Server Load Balancer:CreateLoadBalancerTCPListener

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

You can query the region ID from the Regions and zones list or by calling 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.

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

The tags.

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

• -1: For a pay-by-data-transfer Internet-facing CLB instance, this value can be set to -1, which specifies unlimited bandwidth.
• 1 to 5120: For a pay-by-bandwidth Internet-facing CLB instance, you can specify the maximum bandwidth of each listener. The sum of the maximum bandwidth values that you set for all listeners cannot exceed the maximum bandwidth of the CLB instance.

The routing algorithm. Valid values:

• wrr (default): Backend servers with higher weights receive more requests than backend servers with 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 four factors: 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. If the default value is used, the system disables session persistence.

The timeout period of a connection. Unit: seconds.

Valid values: 10 to 900.

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

Valid values: 2 to 10.

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

Valid values: 2 to 10.

The maximum timeout period of a health check response. Unit: seconds.

Valid values: 1 to 300.

Default value: 5.

The port that is used for health checks.

Valid values: 1 to 65535.

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

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

Valid values: 1 to 50.

The domain name that you want to use for health checks. Valid values:

• $_ip: the private IP address of a backend server. If you do not set the HealthCheckDomain parameter or set the parameter to $_ip, the CLB instance uses the private IP address of each backend server for health checks.
• domain: The domain name must be 1 to 80 characters in length, and can contain 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 only digits, letters, 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 for a successful health check. Separate multiple HTTP status codes with commas (,). Valid values:

• http_2xx(default)
• http_3xx
• http_4xx
• http_5xx

The type of health checks. Valid values:

• tcp (default)
• http

The ID of the vServer group.

The ID of the primary/secondary server group.

The ID of the network ACL that is associated with the listener.

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.

  Your service may be adversely affected if the whitelist is not properly configured.

  If a whitelist is configured, only requests from IP addresses that are added to the whitelist are forwarded by the listener. If a whitelist is configured but no IP address is added to the whitelist, the 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 a blacklist is configured for a listener but no IP address is added to the blacklist, the listener forwards all requests.

Specifies whether to enable access control. Valid values:

• on: yes
• off (default): no

The name of the listener.

The name 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: yes
• off: no

The timeout period of connection draining. Unit: seconds.

Valid values: 10 to 900.

Specifies whether to use the Proxy protocol to pass client IP addresses to backend servers. Valid values:

• true: yes
• false (default): no

Specifies whether to enable the health check feature. Valid values:

• on (default): yes
• off: no