CreateLoadBalancerTCPListener

The operation that you want to perform.

Set the value to CreateLoadBalancerTCPListener.

The maximum bandwidth value of the listener. Valid values: -1 and 1 to 5120.

-1: For a pay-by-data-transfer Internet-facing SLB instance, you can set the value to -1. This indicates that the bandwidth is unlimited.

1 to 5120: For a pay-by-bandwidth Internet-facing SLB instance, you can specify a bandwidth cap for each listener. The sum of maximum bandwidth values that you set for all listeners cannot exceed the maximum bandwidth value of the SLB instance.

The frontend port that is used by the SLB instance.

Valid values: 1 to 65535.

The ID of the SLB instance.

The region where the SLB instance is created.

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

The backend port that is used by the SLB instance.

Valid values: 1 to 65535.

If the VServerGroupId parameter is not set, this parameter is required.

The scheduling algorithm. Valid values:

• wrr (default): Backend servers that have higher weights receive more requests than those that have lower weights.
• rr: Requests are sequentially distributed to backend servers.
• 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 four factors: source IP address, destination IP address, source port number, and destination port number. Requests that contain the same preceding information are distributed to the same backend server.

The consistent hashing (CH) algorithm is supported in the following regions:

• Japan (Tokyo)
• India (Mumbai)
• Singapore Zone B and Singapore Zone C
• Australia (Sydney)
• Malaysia (Kuala Lumpur)
• Indonesia (Jakarta)
• Germany (Frankfurt)
• UK (London)
• UAE (Dubai)
• US (Silicon Valley)
• US (Virginia)
• Hongkong Zone B and Hongkong Zone C
• Beijing Zone C, Beijing Zone D, Beijing Zone E, Beijing Zone F, Beijing Zone G, and Beijing Zone H.
• Chengdu Zone A
• Hangzhou Zone B, Hangzhou Zone C, Hangzhou Zone E, Hangzhou Zone F, Hangzhou Zone I, and Hangzhou Zone H
• China (Hohhot)
• Qingdao Zone B and Qingdao Zone C
• Shanghai Zone B, Shanghai Zone D, Shanghai Zone E, Shanghai Zone F, Shanghai Zone G, Shanghai Zone H, and Shanghai Zone J.
• Shenzhen Zone B, Shenzhen Zone C, Shenzhen Zone D, and Shenzhen Zone E.
• Zhangjiakou Zone A and Zhangjiakou Zone B

The timeout period of session persistence.

Valid values: 0 to 3600. Unit: seconds.

Default value: 0. This indicates that session persistence is disabled.

The timeout period of connections.

Valid values: 10 to 900. Unit: seconds.

The number of consecutive successful health checks that must occur before an unhealthy backend server is declared healthy. In this case, the health check state is changed from fail to success.

Valid values: 2 to 10.

The number of consecutive failed health checks that must occur before a healthy backend server is 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.

Valid values: 1 to 300. Unit: seconds.

Default value: 5.

The port that is used for health checks.

Valid values: 1 to 65535.

If this parameter is not set, the port specified by BackendServerPort is used for health checks.

The time interval between two consecutive health checks.

Valid values: 1 to 50. Unit: seconds.

The domain name that is used for health checks. Valid values:

• $_ip: The private IP address of the backend server. If the $_ip parameter is set or the HealthCheckDomain parameter is not set, SLB uses the private IP addresses of backend servers as the domain names for health checks.
• domain: The domain name must be 1 to 80 characters in length, and can contain only letters, digits, periods (.),and hyphens (-).

The 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 (%), number signs (#), and ampersands (&). The URI must start with a forward slash (/) but cannot be a single forward slash (/).

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.

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

Valid values:

• http_2xx(default value)
• http_3xx
• http_4xx
• http_5xx

The type of health check.

Valid values:

• tcp(default value)
• http

The ID of the vServer group.

The ID of the primary/secondary server group.

The ID of the Access Control List (ACL) to which the listener is bound.

This parameter is required when the AclStatus parameter is set to on.

The type of ACL.

• white: specifies the ACL as a whitelist. Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. Whitelists apply to scenarios where only specific IP addresses are allowed to access an application.

  Risks may occur if the whitelist is improperly set.

  After you set a whitelist for an SLB listener, only requests from IP addresses that are added to the whitelist are distributed by the listener.

  If the whitelist is enabled without IP addresses specified, the SLB listener does not forward requests.

• black: specifies the ACL as a blacklist. All requests from the IP addresses or CIDR blocks in the ACL are rejected. Blacklists apply to scenarios that require you to block access from specific IP addresses to an application.

  If the blacklist is enabled but the corresponding ACL does not contain IP addresses, the SLB listener forwards all requests.

This parameter takes effect if the AclStatus parameter is set to on.

Specifies whether to enable the access control feature.

Valid values:

• on
• off(default value)

The description of the listener.

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

Specifies whether to enable connection draining. Valid values:

• on: enables connection draining.
• off: disables connection draining.

The timeout period for the connection draining feature. If ConnectionDrain is set to on, this parameter is required.

Value values: 10 to 900. Unit: seconds.

The ID of the request.