SetLoadBalancerHTTPListenerAttribute

The operation that you want to perform.

Set the value to SetLoadBalancerHTTPListenerAttribute.

The listener port of the SLB instance.

Valid values: 1 to 65535.

The ID of the SLB instance.

The region where the SLB instance is deployed.

You can retrieve the region ID from the Regions and zones list or by calling the DescribeRegionsoperation.

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

• -1: For a pay-by-traffic Internet-facing SLB instance, set the peak bandwidth to-1. This indicates that the peak bandwidth is not limited.

Specifies whether to use the X-Forwarded-For header to obtain the real IP address of the client.

Set the value to on.

The scheduling algorithm. Valid values:

• wrr: A backend server with a higher weight is expected to receive more requests.
• rr: Requests are distributed to each backend server on a rotation.

Specifies whether to enable session persistence.

Valid values: on and off.

The method used to handle a cookie. Valid values:

• insert: Insets a cookie.

  SLB inserts a cookie (SERVERID) to the first HTTP or HTTPS response packet sent to a client. The next request from the client will contain the cookie, and the listener will deliver the request to the backend server with the specified SERVERID.

• server: Rewrites a cookie.

  When SLB detects a user-defined cookie, it overwrites the original cookie with the user-defined cookie. The next request from the client will contain the user-defined cookie, and the listener will distribute the request to the recorded backend server.

  Note If you set the StickySession parameter to on, you must specify this parameter.

The timeout period of a cookie. Unit: seconds.

Valid values: 1 to 86400.

The cookie configured on the backend server.

The cookie must be 1 to 200 characters in length and can contain ASCII letters and digits. It cannot contain commas (,), semicolons (;), or spaces. It cannot start with a dollar sign ($).

Specifies whether to enable health check.

Valid values: on and off.

The domain name used for health check. Valid values:

• $_ip: The private IP address of the backend server. If the $_ip parameter is specified or the HealthCheckDomain parameter is not specified, SLB uses the private IP addresses of backend servers as the domain names for health check.
• 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 value must be 1 to 80 characters in length and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL must start with a forward slash (/).

The number of consecutive health check successes required before a backend server is declared healthy (from fail to success).

Valid values: 2 to 10.

The number of consecutive health check failures required before a backend server is declared unhealthy (from success to fail).

Valid values: 2 to 10.

The response timeout period. If the backend ECS instance does not send an expected response within the specified period of time, the health check fails. Unit: seconds. This parameter only takes effect when the HealthCheck parameter is set to on.

Valid values: 1 to 300 .

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

Valid values: 1 to 50 .

The port used for health checks.

Valid values: 1 to 65535.

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

Valid values:http_2xx, http_3xx, http_4xx, and http_5xx.

Specifies whether to use a VServer group.

Valid values: on and off.

The ID of the VServer group.

Specifies whether to use the SLB-IP header to obtain the real IP address of the client.

Valid values: on and off.

Specifies whether to use the SLB-ID header to obtain the ID of the SLB instance.

Valid values: on and off.

Specifies whether to use the X-Forwarded-Proto header to obtain the listener protocol of the SLB instance.

Valid values: on and off.

Specifies whether to enable Gzip compression to compress files of a specific type.

Valid values: on and off.

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 the Access Control List (ACL). Valid values: white and black.

• white: Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. The whitelist is used to allow only specified IP addresses to access an application.

  Enabling the whitelist may pose risks to your workloads.

  After the whitelist is enabled, only the IP addresses in the ACL can access the SLB listener.

  If a whitelist is enabled and no IP address is specified, the SLB listener does not forward any requests.

• black: All requests from the IP addresses or CIDR blocks in the ACL are denied. The blacklist is used to forbid specified IP addresses from accessing an application.

  If a blacklist is enabled and no IP address is specified, the SLB listener will forward all requests.

Specifies whether to enable access control for the listener.

Valid values: on and off.

The timeout period of an idle connection. Valid values: 1 to 60. Default value: 15. Unit: seconds.

If no request is received during the specified timeout period, SLB closes the connection and starts a new connection when it receives a new connection request.

The timeout period of a request. Valid values: 1 to 180. Unit: seconds. Default value: 60.

If the backend server does not respond within the specified timeout period, SLB returns an HTTP 504 error to the client.

The description of the listener.