SetLoadBalancerTCPListenerAttribute__Listener相关API_API 参考_负载均衡-阿里云

描述

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

请求参数

名称	类型	是否必须	描述
Action	String	是	操作接口名，系统规定参数。取值：SetLoadBalancerTCPListenerAttribute
LoadBalancerId	String	是	负载均衡实例的唯一标识。
Bandwidth	Integer	是	监听的带宽峰值。取值：-1/1-1000Mbps 针对按固定带宽计费方式的公网类型实例，不同Listener上的Bandwidth分配的带宽峰值总和不能超出在创建负载均衡实例时设定的Bandwidth值，且不能将Listener上的Bandwidth设置为-1；针对按使用流量计费方式的公网类型实例，可以选择将Listener上的Bandwidth设置为-1，表示不限制带宽峰值。
ListenerPort	Integer	是	负载均衡实例前端使用的端口。取值：1-65535
SynProxy	String	否	是否开启SynProxy，SynProxy是负载均衡的攻击防护功能。建议用户一般情况下不要调整这个参数，由负载均衡控制。取值：enable \| disable 默认值：disable
Scheduler	String	否	调度算法。取值：wrr/wlc 默认值：无用户不指定此参数时，表示此次调用不修改此配置项，保持之前的配置。
PersistenceTimeout	Integer	否	连接持久化的超时时间。取值： 0-1000（单位为秒）默认值：无用户不指定此参数时，表示此次调用不修改此配置项，保持之前的配置。其中，0表示关闭。
HealthCheckType	String	否	健康检查类型。取值：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。当TCP监听需要使用HTTP健康检查时可配置此参数。如不配置则按TCP健康检查取值：长度限制为1-80，必须以’/’开头。只能使用字母、数字、‘-’、‘/’、‘.’、‘%’、‘?’、‘#’、‘&’这些字符。
HealthCheckConnectPort	Integer	否	进行健康检查时使用的端口。取值：1-65535 默认值：无用户不设置此参数时，表示使用后端服务端口（BackendServerPort）。
HealthyThreshold	Integer	否	判定健康检查结果为success的阈值。即，健康检查连续成功多少次后，将后端服务器的健康检查结果由fail改为success。用户不指定此参数时，表示此次调用不修改此配置项，保持之前的配置。取值：1-10 默认值：无
UnhealthyThreshold	Integer	否	判定健康检查结果为fail的阈值。即，健康检查连续失败多少次后，将后端服务器的健康检查状态由success改为fail。取值：1-10 默认值：无用户不指定此参数时，表示此次调用不修改此配置项，保持之前的配置。
HealthCheckConnectTimeout	Integer	否	每次健康检查响应的最大超时时间。取值：1-50（单位为秒）默认值：无用户不指定此参数时，表示此次调用不修改此配置项，保持之前的配置。
HealthCheckInterval	Integer	否	进行健康检查的时间间隔。取值：1-5（单位为秒）默认值：无用户不指定此参数时，表示此次调用不修改此配置项，保持之前的配置。
HealthCheckHttpCode	String	否	健康检查正常的http状态码，多个http状态码间用”,”分割。当TCP监听需要使用HTTP健康检查时可配置此参数。如不配置则按TCP健康检查。取值：http_2xx \| http_3xx \| http_4xx \| http_5xx 默认值：http_2xx
VServerGroup	String	否	是否使用虚拟服务器组，取值：on/off，默认值：off；增加一个入参VServerGroupId，非必选，虚拟服务器组ID。
VServerGroupId	String	否	虚拟服务器组ID。

返回参数

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

示例

请求示例

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

返回示例

XML格式

      <?xml version="1.0" encoding="UTF-8"?>
      <SetLoadBalancerTCPListenerAttributeResponse>
          <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
      </SetLoadBalancerTCPListenerAttributeResponse>

JSON格式

      {"RequestId":" CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
      }

最后更新：2016-11-23 16:03:57

SetLoadBalancerTCPListenerAttribute__Listener相关API_API 参考_负载均衡-阿里云

描述

请求参数

返回参数

示例

请求示例

返回示例

上一篇： SetLoadBalancerHTTPSListenerAttribute__Listener相关API_API 参考_负载均衡-阿里云

下一篇： SetLoadBalancerUDPListenerAttribute__Listener相关API_API 参考_负载均衡-阿里云

相关内容

热门内容

最新内容