SetLoadBalancerTCPListenerAttribute

The operation that you want to perform.

Set the value to SetLoadBalancerTCPListenerAttribute.

The frontend port that is used by the CLB instance.

Valid values: 1 to 65535.

The ID of the CLB instance.

The region ID of the CLB instance.

You can query the region ID from the Regions and zones list or by calling the DescribeRegions operation.

The maximum bandwidth of the listener. Unit: Mbit/s. Valid values: -1 and 1 to 5120.

• -1: For a pay-by-data-transfer Internet-facing CLB instance, you can set this parameter to -1. In this case, the bandwidth of the listener is unlimited.
• 1 to 5120: For a pay-by-bandwidth Internet-facing CLB instance, you can specify the bandwidth limit of each listener. The sum of bandwidth limit values that you set for all listeners cannot exceed the bandwidth limit of the CLB instance.

The scheduling algorithm. Valid values:

• wrr: Backend servers that have higher weights receive more requests than backend servers that have lower weights.
• rr: Requests are distributed to backend servers in sequence.
• sch: specifies consistent hashing that is based on source IP addresses. Requests from the same source IP address are distributed to the same backend server.
• tch: specifies consistent hashing that is based on the following parameters: source IP address, destination IP address, source port, and destination port. Requests that contain the same preceding information are distributed to the same backend server.

The timeout period of session persistence. Unit: seconds. Valid values: 0 to 3600.

The default value is 0, which specifies to disable session persistence.

The timeout period of connections. Unit: seconds.

Valid values: 10 to 900.

The number of health checks that an unhealthy backend server must consecutively pass before it can be declared healthy. In this case, the health check state is changed from fail to success.

Valid values: 2 to 10.

The number of health checks that a healthy backend server must consecutively fail before it can be declared unhealthy. In this case, the health check state is changed from success to fail.

Valid values: 2 to 10.

The timeout period of a health check response.

If a backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the ECS instance is considered unhealthy.

Valid values: 1 to 300.

The port that is used for health checks.

Valid values: 1 to 65535.

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

The time interval between two consecutive health checks. Unit: seconds.

Valid values: 1 to 50.

The domain name that is used for health checks. You can set this parameter when the TCP listener requires HTTP health checks. If you do not set this parameter, TCP health checks are performed.

• $_ip: the private IP address of a backend server.

  If an IP address is specified or the parameter is not set, the CLB instance uses the private IP address of the backend server as the domain name for health checks.

• domain: The domain name must be 1 to 80 characters in length, and can contain letters, digits, periods (.),and hyphens (-).

The uniform resource identifier (URI) that is used for health checks. The URI must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URI must start with a forward slash (/) but cannot be a single forward slash (/).

You can set this parameter to enable HTTP health checks for the TCP listener.

If this parameter is not set, TCP health checks are performed.

The HTTP status code that indicates a successful health check. Separate multiple HTTP status codes with commas (,).

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

The type of health checks. Valid values: tcp and http.

Specifies whether to enable the SynProxy feature of CLB for protection.

Valid values:

• enable: yes
• disable: no

We recommend that you use the default value of this parameter.

Specifies whether to use a vServer group. Valid values:

• on: yes
• off: no

The ID of the vServer group.

The ID of the primary/secondary server group.

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

• on: yes
• off: no

You cannot set both VserverGroup and MasterSlaveServerGroup to on.

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

If AclStatus is set to on, this parameter is required.

The type of the ACL. Valid values:

• white: a whitelist. Only requests from the IP addresses or CIDR blocks in the network ACL are forwarded. Whitelists apply to scenarios where you want to allow only specific IP addresses to access an application. Risks may arise if the whitelist is improperly set. After the whitelist is set, only requests from IP addresses that are added to the whitelist are forwarded by the listener.

  If the whitelist does not contain IP addresses, the CLB listener forwards all requests.

• black: a blacklist. All requests from the IP addresses or CIDR blocks in the ACL are rejected. Blacklists apply to scenarios where you want to block access from specified IP addresses to an application.

  If no IP address is added to the blacklist, the listener forwards all requests.

Specifies whether to enable the access control feature. Valid values:

• on: yes
• off: no

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

Specifies whether to enable connection draining. Valid values:

• on: yes
• off: no

The timeout period for connection draining. This parameter is required if ConnectionDrain is set to on. Unit: seconds.

Valid values: 10 to 900.

The ID of the request.