SetLoadBalancerTCPListenerAttribute

The name of this action.

Value: SetLoadBalancerTCPListenerAttribute

The frontend port used by the SLB instance.

Value range: 1 to 65535

The ID of the SLB instance.

The ID of the region to which the SLB instance belongs.

To query the region ID, refer to the list ofregions and zones or call DescribeRegions.

Optional. The ID of the access control list associated with the listener.

If the value of the AclStatus parameter is on, this parameter is required.

Optional. Indicates whether to enable access control.

Valid values: on | off

Optional. The access control method:

• white: Only requests from IP addresses or CIDR blocks in the selected access control list are forwarded. It applies to scenarios where the application only allows access from some specific IP addresses.

  Enabling a whitelist poses some risks to your services.

  After a whitelist is configured, only the IP addresses in the list can access the listener.

  If you enable a whitelist without adding any IP addresses in the list, all requests are forwarded.

• black: Requests from IP addresses or CIDR blocks in the selected access control list are not forwarded. It applies to scenarios where the application only denies access from some specific IP addresses.

  If you enable a blacklist without adding any IP addresses in the list, all requests are forwarded.

If the value of the AclStatus parameter is on, this parameter is required.

Optional. The peak bandwidth of the listener. Unit: Mbit/s. Valid values: -1 | 1 to 5120

• -1: You can set the peak bandwidth of an Internet SLB instance that is billed by traffic to -1. Then, the peak bandwidth is not restricted.
• 1 to 5120: You can set one peak bandwidth for each listener of an Internet SLB instance that is billed by bandwidth. However, the sum of the peak bandwidth values of all listeners cannot exceed the peak bandwidth of the SLB instance. For more information, see Share bandwidth.

Optional. A description of the TCP listener.

Optional. The timeout value of the TCP connection.

Value range: 10 to 900. Unit: seconds

Optional. The port used for health checks. Value range: 1 to 65535

If you do not set this parameter, the backend server port (BackendServerPort) is used.

Optional. The length of time to wait for the response from the health check.

If the backend ECS instance does not send a correct response within the specified time, the health check fails.

Value range: 1 to 300. Unit: seconds

Optional. The domain name 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 the backend server.

  When the IP address is specified or this parameter is not specified, SLB uses 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 only contain letters, numbers, periods (.), and hyphens (-).

Optional. The HTTP status code indicating that the health check is normal. Separate multiple HTTP status codes by commas (,).

Valid values: http_2xx | http_3xx | http_4xx | http_5xx

Optional. The time interval between two consecutive health checks. Value range: 1 to 50. Unit: seconds

Optional. The health check type.

Valid values: tcp | http

Optional. The URI 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.

Optional. The number of consecutive successes of health checks before a backend server is declared as healthy (from failure to success).

Value range: 2 to 10

Optional. Indicates whether to use an active/standby server group.

Valid values: on | off

The value of VServerGroup and the value of MasterSlaveServerGroup cannot be on at the same time.

Optional. The ID of the active/standby server group.

Optional. The timeout value of the session persistence. Value range: 0 to 3600. Unit: seconds

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

Optional. The algorithm used to distribute traffic. Value values:

• wrr: A backend server with a higher weight is more likely to be polled.
• wlc: A server with a higher weight receives more requests. When the weight values of two backend servers are the same, the server with a smaller number of connections is more likely to be polled.
• rr: Requests are evenly and sequentially distributed to backend servers.
• sch: A consistent hash based on source IP addresses. Requests with the same source IP addresses are scheduled to the same backend server.
• tch: A consistent hash based on the following four variables: source IP address + destination IP address + source port + destination port. The same streams are scheduled to the same backend server.

Optional. Indicates whether to enable SynProxy. SynProxy protects SLB from attacks.

We recommend that you retain the value set by SLB in this parameter.

Valid values: enable | disable

Optional. The number of consecutive failures of health checks before a backend server is declared as unhealthy (from success to failure).

Value range: 2 to 10

Optional. Indicates whether to use a VServer group.

Valid values: on | off

The value of VServerGroup and the value of MasterSlaveServerGroup cannot be on at the same time.

Optional. The ID of the VServer group.

The ID of the request.