Server Load Balancer:SetLoadBalancerHTTPListenerAttribute

The region ID of the SLB instance.

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

The ID of the SLB instance.

The frontend port used by the SLB instance.

Valid values: 1 to 65535.

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

• -1: For a pay-by-traffic Internet-facing SLB instance, you can set the peak bandwidth to -1, which specifies unlimited bandwidth.

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

• on (default): yes.

• off: no.

The scheduling algorithm. Valid values:

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

• 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 sends a request for the first time, the Server Load Balancer (SLB) instance inserts a cookie into the response (inserts SERVERID into the HTTP/HTTPS response). The next time the client sends a request with this cookie, the SLB instance forwards the request to the previously recorded backend server.

• server: rewrite cookie.

When the SLB instance discovers a user-defined cookie, it rewrites the original cookie. The next time the client sends a request 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 value 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 health checks. Valid values:

• on: yes.

• off: no.

The health check method used by the HTTP listener. Valid values: head and get.

The domain name used for health checks. Valid values:

• $_ip: the private IP address of the backend server. If $_ip is specified or HealthCheckDomain is not specified, the SLB instance uses the private IP address 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 value 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 before the health check status of a backend server changes from fail to success.

Valid values: 2 to 10.

The number of consecutive failed health checks before the health check status of a backend server changes from success to fail.

Valid values: 2 to 10.

The amount of time to wait for a response from a health check. If the backend ECS instance does not respond within the specified time, 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 for a successful health check. Separate multiple 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: yes.

• off: no.

The ID of the vServer group.

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

• on: yes.

• off: no.

Specifies whether to use the SLB-ID header field to obtain the ID of the SLB instance. Valid values:

• on: yes.

• off: no.

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

• on: yes.

• off: no.

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

• on: yes.

• off: no.

The ID of the access control policy group bound to the listener.

The type of access control. Valid values:

• white: Only requests from the IP addresses or CIDR blocks in the selected access control policy group are forwarded. Whitelists are applicable to scenarios in which you want to allow only specific IP addresses to access your service. Enabling a whitelist poses some risks. After a whitelist is enabled, only the IP addresses in the whitelist can access the SLB listener.

If a whitelist is enabled but no IP address is added to the access control policy group, the SLB listener forwards all requests.

• black: All requests from the IP addresses or CIDR blocks in the selected access control policy group are rejected. Blacklists are applicable to scenarios in which you want to block access from specific IP addresses.

If a blacklist is enabled but no IP address is added to the access control policy group, 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 connection and re-establishes the connection when the next request arrives.

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

If no response is received from the backend server 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 field to obtain the listener port of the SLB instance. Valid values:

• on: yes.

• off: no.

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

• on: yes.

• off: no.