SetLoadBalancerTCPListenerAttribute - Developer Guide| Alibaba Cloud Documentation Center

Description

Configure HTTP Listener, including Scheduler, SticySession and HealthCheck.

Request parameter

Name	Type	Mandatory or not	Description
Action	String	Yes	Name of the operating interface, which is specified in the system Value：SetLoadBalancerTCPListenerAttribute
LoadBalancerId	String	Yes	The unique ID of an Server Load Balancer instance
Bandwidth	Integer	Yes	Bandwidth peak of Listener Value：-1 \| 1-1000Mbps For the public network instance charged per traffic consumed, the Bandwidth on Listener can be set to -1, indicating the bandwidth peak is unlimited.
ListenerPort	Integer	Yes	Port used by the Server Load Balancer instance frontend Value：1-65535
SynProxy	String	否	Whether to open SynProxy，SynProxy is the protection function of Server Load Balancer. It is recommended that users generally do not adjust this parameter. Value：enable \| disable Default：disable
Scheduler	String	No	Scheduling algorithm Value：wrr \| wlc Default：None When the parameter is not specified by the user, it means this configuration item is not changed in the call, and the former configuration is maintained.
PersistenceTimeout	Integer	No	Timeout of connection persistence Value： 0-3600 (in seconds) Default：None When the parameter is not specified by the user, it means this configuration item is not changed in the call, and the former configuration is maintained. The value 0 indicates to close it.
HealthCheckDomain	String	No	Domain name used for health check. When TCP listener need to use HTTP health check, the parameter is mandatory. Otherwise, the parameter will be ignored. Value：$_ip \| custom string Rules of the custom string: its length is limited to 1-80 and only characters such as letters, digits, ‘-‘ and ‘.’ are allowed. When the parameter is set to $_ip by the user, Server Load Balancer uses the private network IP address of each backend server as Domain used for health check. 。
HealthCheckURI	String	As appropriate	URI used for health check. When TCP listener need to use HTTP health check, the parameter will be configured. If it is not configured, TCP health check will be used. Value：Its length is limited to 1-80 and it must start with /. Only characters such as letters, digits, ‘-’, ‘/’, ‘.’, ‘%’, ‘?’, #’ and ‘&’ are allowed.
HealthyThreshold	Integer	No	Threshold determining the result of the health check is success. Namely, after how many successive successful health checks, the health check result of the backend server is changed from fail to success. Value：1-10 Default：None
UnhealthyThreshold	Integer	No	Threshold determining the result of the health check is fail. Namely, after how many successive failed health checks, the health check result of the backend server is changed from success to fail. Value：1-10 Default：None
HealthCheckConnectTimeout	Integer	No	Maximum timeout of each health check response. Value：1-50 (in seconds) Default：None
HealthCheckInterval	Integer	No	Time interval of health checks. Value： 1-5 (in seconds) Default：None
HealthCheckHttpCode	String	No	Regular health check HTTP status code. Multiple codes are segmented by “,”. When HTTP health check is required for TCP listening, configure this parameter; if this parameter is not configured, TCP health check will be used. Value: http_2xx \| http_3xx / http_4xx / http_5xx Default: http_2xx
VServerGroup	String	No	Whether to use virtual server group. It can be on or off. The default value is off. VserverGroup and MasterSlaveServerGroup cannot be both set to on.
VServerGroupId	String	No	Virtual server group ID. The VServerGroupId value takes effect only when VserverGroup is set to on.
MasterSlaveServerGroup	String	No	Whether to use master-slave server group. It can be on or off. The default value is off. VserverGroup and MasterSlaveServerGroup cannot be both set to on.
MasterSlaveServerGroupId	String	No	Master-slave server group ID. The MasterSlaveserverGroupId value takes effect only when MasterSlaveserverGroup is set to on.

Return parameter

They are all common return parameters. See Public Parameters for details.

Example

Request example

    https://slb.aliyuncs.com/
    &Action=SetLoadBalancerTCPListenerAttribute
    &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
    &ListenerPort=443
    &VServerGroup=on
    &VServerGroupId=rsp-cige6j5e7p
    &<common request parameter>

Return example

XML format

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

JSON format

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