SetLoadBalancerHTTPListenerAttribute

The region ID of the SLB instance.

You can obtain the region ID from the Regions and zones list or invoke the DescribeRegions operation.

The ID of the SLB instance.

The frontend port used by the SLB instance.

Valid values: 1 to 65535.

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

• -1: For an Internet-facing SLB instance with traffic-based billing, you can set the maximum bandwidth to -1, which means the bandwidth is not limited.

• 1 to 5120 (Mbit/s): For an Internet-facing SLB instance with bandwidth-based billing, you can configure the maximum bandwidth for each listener. However, the sum of the maximum bandwidth values of all listeners cannot exceed the maximum bandwidth of the instance. For more information, see Share the bandwidth of an SLB instance.

Specifies whether to use the X-Forwarded-For header to retrieve the originating IP address of the client request. Valid values:

• on (default): yes.

• off: no.

The scheduling algorithm. Valid values:

• wrr: Backend servers with higher weights receive more requests.

• rr: Requests are distributed to backend servers in sequence.

Specifies whether to enable session persistence. Valid values:

• on: yes.

• off: no.

The method used to handle cookies. Valid values:

• insert: insert cookie.

When a client accesses the SLB instance for the first time, the SLB instance uses the insert cookie method (by inserting SERVERID into the HTTP/HTTPS response message). The next time the client accesses the SLB instance with this cookie, the SLB instance forwards the request to the previously recorded backend server.

• server: rewrite cookie.

When the SLB instance detects a user-defined cookie, it rewrites the original cookie. The next time the client accesses the SLB instance with the new cookie, the SLB instance forwards the request to the previously recorded backend server.

The timeout period of the cookie.

Valid values: 1 to 86400. Unit: seconds.

The cookie configured on the server.

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

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

• on: yes.

• off: no.

The HTTP method used for health checks. Valid values: head and get.

The domain name used for health checks. Valid values:

• $_ip: the private IP of the backend server. If $_ip is specified or HealthCheckDomain is not specified, the SLB instance uses the private IP of each backend server as the domain name for health checks.

• 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 URI must be 1 to 80 characters in length and can contain only letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URI cannot be only a forward slash (/) but must start with a forward slash (/).

The number of consecutive successful health checks that must occur before the health status of a backend server is changed from fail to success.

Valid values: 2 to 10.

The number of consecutive failed health checks that must occur before the health status of a backend server is changed from success to fail.

Valid values: 2 to 10.

The timeout period for a health check response. If a backend Elastic Compute Service (ECS) instance does not send a correct response within the specified timeout period, the health check fails. This parameter takes effect only when HealthCheck is set to on.

Valid values: 1 to 300. Unit: seconds.

The interval between two consecutive health checks.

Valid values: 1 to 50. Unit: seconds.

The port used for health checks.

Valid values: 1 to 65535.

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

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

Specifies whether a vServer group is used. Valid values:

• on: yes.

• off: no.

The ID of the vServer group.

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

• on: yes.

• off: no.

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

• on: yes.

• off: no.

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

• on: yes.

• off: no.

Specifies whether to enable Gzip compression to compress specific file types. Valid values:

• on: yes.

• off: no.

The ID of the access control list (ACL) associated with the listener.

The access control type. Valid values:

• white: a whitelist. Only requests from the IP addresses or CIDR blocks in the selected access control policy group are forwarded. A whitelist applies to scenarios in which you want to allow only specific IP addresses to access an application. Configuring a whitelist poses certain business risks. After a whitelist is configured, only the IP addresses in the whitelist can access the SLB listener.

If you enable a whitelist but the access control policy group does not contain any IP addresses, the SLB listener forwards all requests.

• black: a blacklist. All requests from the IP addresses or CIDR blocks in the selected access control policy group are blocked. A blacklist applies to scenarios in which you want to block access from specific IP addresses to an application.

If you enable a blacklist but the access control policy group does not contain any IP addresses, the SLB listener forwards all requests.

Specifies whether to enable access control. Valid values:

• on: yes.

• off: no.

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

If no access request is received within the specified timeout period, the SLB instance temporarily breaks the current connection. When a new request arrives, the SLB instance establishes a new connection.

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

If a backend server does not send a response within the specified timeout period, the SLB instance stops waiting and 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 SLB instance. Valid values:

• on: yes.

• off: no.

Specifies whether to use the XForwardedFor_ClientSrcPort header to retrieve the port of the client that accesses the SLB instance. Valid values:

• on: yes.

• off: no.

Specifies whether to only precheck the request. Valid values:

• true: The request is prechecked but not executed. If the request passes the precheck, the DryRunOperation error code is returned.

• false (default): The request is prechecked. If the request passes the precheck, the operation is performed.