开发者社区 问答 正文

监听相关API:SetLoadBalancerTCPListenerAttribute


描述


配置TCP Listener,包括Scheduler,StickySession,HealthCheck等。

请求参数


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    

名称类型是否必须描述
ActionString    操作接口名,系统规定参数。取值:SetLoadBalancerTCPListenerAttribute。
RegionIdString地域ID。
LoadBalancerIdString负载均衡实例的唯一标识。
ListenerPort Integer负载均衡实例前端使用的端口。取值:1-65535。
Bandwidth Integer监听的带宽峰值。
取值:-1/1-1000Mbps
针对按固定带宽计费方式的公网类型实例,不同Listener上的Bandwidth分配的带宽峰值总和不能超出在创建负载均衡实例时设定的Bandwidth值,且不能将Listener上的Bandwidth设置为-1;针对按使用流量计费方式的公网类型实例,可以选择将Listener上的Bandwidth设置为-1,表示不限制带宽峰值。
SynProxyString是否开启SynProxy,SynProxy是负载均衡的攻击防护功能。建议用户一般情况下不要调整这个参数,由负载均衡控制。
取值:enable / disable
默认值:disable。
SchedulerString取值:wrr/wlc
默认值:无
用户不指定此参数时,表示此次调用不修改此配置项,保持之前的配置。
PersistenceTimeoutInteger连接持久化的超时时间。
取值: 0-3600(单位为秒)
默认值:无 用户不指定此参数时,表示此次调用不修改此配置项,保持之前的配置。
其中,0表示关闭。
HealthCheckTypeString健康检查类型。
取值:tcp/http
默认值:tcp
TCP协议支持使用TCP和HTTP两种健康检查方式,可根据应用情况选择需要的健康检查方式。
HealthCheckDomain String用于健康检查的域名。当TCP监听需要使用HTTP健康检查时可配置此参数,如不配置则按TCP健康检查。
取值: $_ip/用户自定义字符串/空
自定义字符串规则:长度限制为1-80,只能使用字母、数字、‘-’、‘.’这些字符。
用户设置此参数为’$_ip’或空时,负载均衡会使用各后端服务器的私网IP当做健康检查使用的Domain。
注:由于有的Region还存在BUG,暂时无法支持健康检查域名设置,我们正在加紧修复该问题。当前请使用TCP健康检查或者不设置HTTP健康检查域名,系统会统一使用各后端服务器的内网IP作为域名。
HealthCheckURI String视情况而定用于健康检查的URI。
当HealthCheck为on时,此参数为必选;当HealthCheck为off时,此参数设置将被忽略。
取值:长度限制为1-80,必须以’/’开头。只能使用字母、数字、‘-’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’这些字符。
HealthCheckConnectPort Integer进行健康检查时使用的端口。
取值:1-65535
默认值:无
用户不设置此参数时,表示使用后端服务端口(BackendServerPort)。
HealthyThreshold Integer判定健康检查结果为success的阈值。即,健康检查连续成功多少次后,将后端服务器的健康检查结果由fail改为success。
用户不指定此参数时,表示此次调用不修改此配置项,保持之前的配置。
取值:1-10
默认值:无
UnhealthyThresholdInteger判定健康检查结果为fail的阈值。即,健康检查连续失败多少次后,将后端服务器的健康检查状态由success改为fail。
取值:1-10
默认值:无
用户不指定此参数时,表示此次调用不修改此配置项,保持之前的配置。
HealthCheckTimeout Integer每次健康检查响应的最大超时时间。
取值:1-50(单位为秒)
默认值:无
用户不指定此参数时,表示此次调用不修改此配置项,保持之前的配置。
HealthCheckIntervalInteger进行健康检查的时间间隔。
取值:1-5(单位为秒)
默认值:无
用户不指定此参数时,表示此次调用不修改此配置项,保持之前的配置。
HealthCheckHttpCode String健康检查正常的http状态码,多个http状态码间用”,”分割。当TCP监听需要使用HTTP健康检查时可配置此参数。如不配置则按TCP健康检查。
取值:http_2xx | http_3xx / http_4xx / http_5xx
默认值:http_2xx。
VServerGroupString是否使用虚拟服务器组,取值:on/off,默认值:off;VserverGroup和MasterSlaveServerGroup只允许一个值为on。
VServerGroupId String虚拟服务器组ID,当VserverGroup为on时,传入的VServerGroupId值才生效。
MasterSlaveServerGroup String是否使用主备服务器组,取值:on/off,默认值:off;VserverGroup和MasterSlaveServerGroup只允许一个值为on。
MasterSlaveServerGroupId String主备服务器组ID,当MasterSlaveserverGroup为on时,传入的MasterSlaveserverGroupId值才生效。


返回参数


全是公共返回参数,详见 <公共返回参数>

示例



请求示例

  1.     https://slb.aliyuncs.com/
  2.     &Action=SetLoadBalancerTCPListenerAttribute
  3.     &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
  4.     &ListenerPort=443
  5.     &VServerGroup=on
  6.     &VServerGroupId=rsp-cige6j5e7p
  7.     &<公共请求参数>


返回示例

  • XML格式
    1.       <?xml version="1.0" encoding="UTF-8"?>
    2.       <SetLoadBalancerTCPListenerAttributeResponse>
    3.           <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    4.       </SetLoadBalancerTCPListenerAttributeResponse>
  • JSON格式
    1.       {"RequestId":" CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
    2.       }

展开
收起
行者武松 2017-10-18 14:33:00 1954 分享 版权
0 条回答
写回答
取消 提交回答