Server Load Balancer:CreateLoadBalancerTCPListener

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

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

The ID of the CLB instance.

The frontend port used by the CLB instance.

Valid values: 1 to 65535.

The backend port used by the CLB instance.

Valid values: 1 to 65535.

This parameter is required if you do not use a server group (do not specify vServerGroupId).

The peak bandwidth of the listener. Unit: Mbit/s. Valid values:

• -1: For a pay-by-data-transfer Internet-facing SLB instance, you can set the peak bandwidth to -1, which specifies unlimited bandwidth.

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

The scheduling algorithm. Valid values:

• wrr (default): Backend servers with higher weights receive more requests through polling.

• rr: Requests are distributed to backend servers in access sequence.

• sch: Consistent hashing based on source IP addresses. Requests from the same source IP address are distributed to the same backend server.

• tch: Consistent hashing based on the following parameters: source IP address, destination IP address, source port, and destination port. Requests that contain the same information based on the four factors are distributed to the same backend server.

The timeout period of session persistence. Unit: seconds.

Valid values: 0 to 3600.

Default value: 0, which indicates that session persistence is disabled.

The connection timeout period. Unit: seconds.

Valid values: 10 to 900.

The number of consecutive successful health checks that must occur before a backend server is declared healthy. The health check status of the backend server changes from fail to success.

Valid values: 2 to 10.

The number of consecutive failed health checks that must occur before a backend server is declared unhealthy. The health check status of the backend server changes from success to fail.

Valid values: 2 to 10.

The maximum timeout period for each health check response. Unit: seconds.

Valid values: 1 to 300.

Default value: 5.

The port used for health checks.

Valid values: 1 to 65535.

If this parameter is not set, the backend service port (BackendServerPort) is used for health checks.

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

Valid values: 1 to 50.

The domain name used for health checks. Valid values:

• $_ip: the private IP address of the backend server. If you specify $_ip or do not specify this parameter, Server Load Balancer uses the private network IP address of each backend server as the domain name 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 used for health checks. The URI must be 1 to 80 characters in length and can contain only letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), number signs (#), and ampersands (&). The URI cannot be only a forward slash (/) but must start with a forward slash (/).

You can configure this parameter when the TCP listener requires HTTP health checks. If this parameter is not configured, TCP health checks are performed.

The HTTP status code that indicates a Normal health check result. Separate multiple HTTP status codes with commas (,). Valid values:

• http_2xx (default)

• http_3xx

• http_4xx

• http_5xx

The health check type. Valid values:

• tcp (default)

• http

The ID of the vServer group.

The ID of the primary/secondary server group.

The ID of the access control list (ACL) bound to the listener.

The type of access control. Valid values:

• white: Only requests from the IP addresses or CIDR blocks in the selected access control policy group are forwarded. Whitelists are applicable to scenarios in which you want to allow only specific IP addresses to access your service. Configuring a whitelist poses risks to your workloads. After a whitelist is configured, only the IP addresses in the whitelist can access the SLB listener. If a whitelist is enabled but no IP address is added to the access control policy group, the SLB listener forwards all requests.

• black: All requests from the IP addresses or CIDR blocks in the selected access control policy group are denied. Blacklists are applicable to scenarios in which you want to deny access from specific IP addresses. If a blacklist is enabled but no IP address is added to the access control policy group, the SLB listener forwards all requests.

Specifies whether to enable access control. Valid values:

• on: enabled.

• off (default): disabled.

The custom listener name.

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

Specifies whether to enable connection draining. Valid values:

• on: enabled.

• off: disabled.

The timeout period of connection draining. Unit: seconds.

Valid values: 10 to 900.

Specifies whether to use the Proxy Protocol to pass the client source address to the backend server. Valid values:

• true: enabled.

• false (default): disabled.

Specifies whether to enable health checks. Valid values:

• on (default): enabled.

• off: disabled.