SetLoadBalancerHTTPListenerAttribute

The name of this action. Value: SetLoadBalancerHTTPListenerAttribute

The frontend port used by the SLB instance.

Value range: 1 to 65535

The ID of the SLB instance.

The region to which the SLB instance belongs.

To query the region ID, refer to the list of regions and zones or call the DescribeRegions API.

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: Indicates a whitelist. Only requests from the IP addresses or CIDR blocks in the selected access control lists are forwarded. It applies to scenarios where an application allows access only from 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, no requests are forwarded.

• black: Indicates a blacklist. Requests from the IP addresses or CIDR blocks in the selected access control lists are not forwarded (that is, they are blocked). It applies to scenarios where an application denies access only from specific IP addresses.

  If you enable a blacklist without adding any IP addresses to 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 Valid values: -1 | 1 to 5120. Unit: Mbit/s.

• -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.

Optional. The cookie configured on the backend server.

The cookie must be 1 to 200 characters in length and can only contain ASCII English letters and numeric characters. It cannot contain commas (,), semicolons (;), or spaces, nor can it begin with $.

When the value of StickySession is on and the value of StickySessionType is server, this parameter is required.

Optional. The timeout period of the cookie.

Value range: 1 to 86400. Unit: seconds

This parameter is required when the value of StickySession is on and the value of StickySessionType is insert.

Optional. A description of the listener.

Optional. Indicates whether to enable Gzip compression.

Optional. Indicates whether to enable the health check function.

Valid values: on | off.

Optional. The port used for health checks.

Value range: 1 to 65535

Optional. The domain name used for health checks. Valid values:

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

Optional. The HTTPS status codes 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 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 URI used for health checks.

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. Specify the idle connection timeout. Value range: 1 to 60. Default value: 15. Unit: seconds

If no request is received during the specified timeout period, SLB will temporarily terminate the connection and restart the connection when the next request is received.

Optional. Specify the request timeout. Value range: 1 to 180. Default value: 60. Unit: seconds

If no response is received from the backend server during the specified timeout period, SLB will stop waiting and send an HTTP 504 error to the client.

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

• wrr: A backend server with a higher weight is more likely to be polled.

• lc: A server with a higher weight receives more requests.

  When the weight values of two backend servers are the same, the backend server with a smaller number of connections is more likely to be polled.

• rr: Requests are evenly and sequentially distributed to backend servers.

Optional. Indicates whether to enable session persistence. Valid values: on | off

Optional. The method used to handle the cookie. Valid values:

• insert: Insert a cookie.

  SLB adds a cookie to the response (that is, it inserts SERVERID in the HTTP/HTTPS response packet) during the first client request. The next request will contain the cookie and the listener will distribute the request to the same backend server.

• server: Rewrite the cookie.

  SLB will overwrite the original cookie when a new cookie is set. The next time the client carries the new cookie to access SLB, the listener will distribute the request to the previously recorded backend server.

  Note If the value of StickySession is on, this parameter is required.

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

Optional. The ID of the VServer group.

Optional. Indicates whether to get the real IP address of a client request through X-Forwarded-For.

Valid values: on | off. Default value: on

Optional. Indicates whether to use the SLB-ID header field to obtain the SLB instance ID.

Valid values: on | off. Default value: off

If you do not set this parameter, the default value is used.

Optional. Indicates whether to use the SLB-IP header field to obtain the real IP address of a client request.

Valid values: on | off. Default value: off

Optional. Indicates whether to use the X-Forwarded-Proto header field to obtain the listening protocol used by the SLB instance.

Valid values: on | off. Default value: off

If you do not set this parameter, the default value is used.

The ID of the request.