Server Load Balancer:SetLoadBalancerHTTPListenerAttribute

The region ID of the CLB instance.

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

The CLB instance ID.

The frontend port that is used by the CLB instance.

Valid values: 1 to 65535.

The maximum bandwidth of the listener. Unit: Mbit/s. Set the value to

• -1: For a pay-by-data-transfer Internet-facing CLB instance, this value specifies that the bandwidth of the listener is unlimited.

Specifies whether to use the X-Forwarded-For header to preserve client IP addresses. Valid values:

• on (default)
• off

The scheduling algorithm. Valid values:

• wrr: Backend servers that have higher weights receive more requests than backend servers that have lower weights.
• rr: Requests are distributed to backend servers in sequence.

Specifies whether to enable session persistence. Valid values:

• on
• off

The method that is used to handle a cookie. Valid values:

• insert: inserts a cookie.

CLB inserts a cookie (SERVERID) into the first HTTP or HTTPS response packet that is sent to a client. The next request from the client contains this cookie, and the listener distributes the request to the recorded backend server.

• server: rewrites a cookie.

When CLB detects a user-defined cookie, CLB overwrites the original cookie with the user-defined cookie. The next request from the client carries the user-defined cookie, and the listener forwards the request to the recorded backend server.

The timeout period of a cookie.

Valid values: 1 to 86400. Unit: seconds.

The cookie that is configured on the server.

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

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

• on
• off

The health check method that is used in HTTP health checks. Valid values: head and get.

The domain name that is used for health checks. Valid values:

• $_ip: the private IP address of a backend server. If you specify **$_ip or ignore HealthCheckDomain**, CLB uses the private IP addresses of backend servers as the health check domain names.
• domain: The domain name must be 1 to 80 characters in length, and can contain letters, digits, periods (.), and hyphens (-).

The Uniform Resource Identifier (URI) that you want to use for health checks.

The URI must be 1 to 80 characters in length, and can contain letters, digits, and the following characters: - / . % ? # & The URI must start with a forward slash (/) but cannot be a single forward slash (/).

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 timeout period of a health check response. If a backend ECS instance does not respond within the specified timeout period, the ECS instance fails the health check. This parameter takes effect only if the HealthCheck parameter is set to on.

Valid values: 1 to 300. Unit: seconds.

The interval at which health checks are performed.

Valid values: 1 to 50. Unit: seconds.

The port that is used for health checks.

Valid values: 1 to 65535.

The HTTP status code for a successful health check. 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
• off

The ID of the vServer group.

Specifies whether to use the SLB-IP header to retrieve the virtual IP address (VIP) requested by the client. Valid values:

• on
• off

Specifies whether to use the SLB-ID header to retrieve the ID of the CLB instance. Valid values:

• on
• off

Specifies whether to use the X-Forwarded-Proto header to retrieve the listener protocol. Valid values:

• on
• off

Specifies whether to enable GZIP compression to compress specific types of files. Valid values:

• on
• off

The ID of the access control list (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 ACL are forwarded. Whitelists apply to scenarios where you want to allow only specific IP addresses to access an application. Risks may occur if a whitelist is improperly configured. If a whitelist is configured, only requests from IP addresses that are added to the whitelist are forwarded by the listener.

If you enable a whitelist but do not add an IP address to the ACL, 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 addresses are added to the blacklist, the listener forwards all requests.

Specifies whether to enable access control. Valid values:

• on
• off

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

If no request is received within the specified timeout period, CLB closes the connection. When a request is received, CLB establishes a new connection.

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

If no response is received from the backend server within the request timeout period, CLB returns an HTTP 504 error code to the client.

The description of the listener.

Specifies whether to use the XForwardedFor_SLBPORT header to retrieve the listener port of the CLB instance. Valid values:

• on
• off

Specifies whether to use the XForwardedFor_ClientSrcPort header to retrieve the client port. Valid values:

• on
• off