SetLoadBalancerTCPListenerAttribute

The ID of the region where the Classic Load Balancer (CLB) instance is deployed.

You can find the region ID in the Regions and Availability Zones list or by calling the DescribeRegions operation.

The ID of the Classic Load Balancer (CLB) instance.

The frontend port used by the CLB instance.

Valid values: 1 to 65535.

The peak bandwidth of the listener, in Mbps. Valid values: -1 or 1 to 5120.

• -1: For pay-by-traffic Internet-facing CLB instances, a value of -1 specifies an unlimited peak bandwidth.

• 1 to 5120: For pay-by-bandwidth Internet-facing CLB instances, you can specify a peak bandwidth for each listener. The sum of the peak bandwidths of all listeners cannot exceed the bandwidth of the CLB instance.

The scheduling algorithm. Valid values:

• wrr: Weighted Round Robin. Backend servers with higher weights receive more requests.

• rr: Round Robin. Requests are distributed to backend servers in turn.

• sch: Source IP Hashing. Requests from the same source IP address are routed to the same backend server.

• tch: Four-tuple Hashing. Requests from the same flow, defined by the source IP address, destination IP address, source port, and destination port, are routed to the same backend server.

The session persistence timeout period, in seconds. Valid values: 0 to 3600.

Default value: 0. A value of 0 disables session persistence.

The connection timeout period, in seconds. Valid values: 10 to 900.

The number of consecutive successful health checks required to change a backend server's health status from fail to success.

Valid values: 2 to 10.

The number of consecutive failed health checks required to change a backend server's health status from success to fail.

Valid values: 2 to 10.

The timeout period for a health check response. Unit: seconds. Valid values: 1 to 300.

If a backend server does not respond within the specified timeout period, the health check fails.

The port used for health checks. Valid values: 1 to 65535.

If this parameter is not specified, the port specified by BackendServerPort is used.

The interval between consecutive health checks, in seconds.

Valid values: 1 to 50.

The domain name for health checks. This parameter is valid only when HealthCheckType is set to http.

• $_ip: the private IP address of a backend server. If you set the value to $_ip or do not specify this parameter, the CLB instance uses the private IP address of each backend server as the domain name for health checks.

• domain: a domain name that is 1 to 80 characters in length and can contain letters, digits, periods (.), and hyphens (-).

The URI for health checks. This parameter is valid only when HealthCheckType is set to http.

The URI must be 1 to 80 characters in length and start with a forward slash (/). The URI cannot be a single forward slash. It can contain letters, digits, and the following characters: - / . % ? # &.

If you do not configure this parameter, TCP health checks are performed.

The HTTP status codes that indicate a successful health check. This parameter is valid only when HealthCheckType is set to http. Separate multiple codes with a comma.

Valid values: http_2xx, http_3xx, http_4xx, and http_5xx.

The health check protocol. Valid values: tcp and http.

Specifies whether to enable SynProxy for SYN flood protection. Valid values:

• enable: enables SynProxy.

• disable: disables SynProxy.

We recommend that you do not change the value of this parameter. This setting is managed by the CLB service.

Specifies whether to use a virtual server group. Valid values:

• on: uses a virtual server group.

• off: does not use a virtual server group.

The ID of the virtual server group.

The ID of the primary/secondary server group.

Specifies whether to use a primary/secondary server group. Valid values:

• on: uses a primary/secondary server group.

• off: does not use a primary/secondary server group.

Only one of VServerGroup or MasterSlaveServerGroup can be set to on.

The ID of the access control list (ACL) associated with the listener.

This parameter is required if AclStatus is set to on.

The type of the ACL. Valid values:

• white: a whitelist. The listener forwards only requests from the IP addresses or CIDR blocks in the ACL. Whitelists are suitable for scenarios in which you want to allow access only from specific IP addresses. Using a whitelist poses security risks. If you set AclType to white and the ACL contains no IP addresses, the listener forwards all requests.

  If whitelist access is enabled but no IP addresses are added to the access control group, the load balancer listener forwards all requests.

• black: a blacklist. The listener blocks all requests from the IP addresses or CIDR blocks in the ACL. Blacklists are suitable for scenarios in which you want to deny access from specific IP addresses. If you set AclType to black and the ACL contains no IP addresses, the listener forwards all requests.

  If blacklist access is enabled but no IP addresses are added to the access control policy group, the load balancer listener forwards all requests.

Specifies whether to enable access control. Valid values:

• on: enables access control.

• off: disables access control.

The description of the listener.

The description must be 1 to 256 characters in length and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), and underscores (_).

Specifies whether to enable connection draining. Valid values:

• on: enables connection draining.

• off: disables connection draining.

The timeout for connection draining, in seconds. This parameter is required if ConnectionDrain is set to on.

Valid values: 10 to 900.

Specifies whether to use Proxy Protocol v2 to forward client source IP addresses to backend servers. Valid values:

• true: yes.

• false: no.

Specifies whether to enable health checks. Valid values:

• on: enables health checks.

• off: disables health checks.