SetLoadBalancerHTTPListenerAttribute

The operation that you want to perform.

Set the value to SetLoadBalancerHTTPListenerAttribute.

The frontend port that is used by the CLB instance.

Valid values: 1 to 65535.

The ID of the CLB instance.

The ID of the region where the CLB instance is deployed.

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

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

• -1: For a pay-by-data-transfer Internet-facing CLB instance, you can set this parameter to -1. This indicates that the maximum bandwidth is unlimited.

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

• on: yes
• off: no

The scheduling algorithm. Valid values:

• wrr: Backend servers that have higher weights receive more requests than those that have 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 that is used to handle a cookie. Valid values:

• insert: inserts a cookie.

  CLB inserts the server ID as a cookie into the first HTTP or HTTPS response that is sent to a client. The next request from the client will contain this cookie, and the listener will distribute this request to the recorded backend server.

• server: rewrites the original cookie.

  When CLB 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 this request to the recorded backend server.

  Note This parameter is required if the StickySession parameter is set to on.

The timeout period of the cookie. Unit: seconds.

Valid values: 1 to 86400.

The cookie to be configured on the backend 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 health checks.

Valid values:

• on: yes
• off: no

The HTTP method that is used for 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 this parameter is set to $_ip or is not set, CLB 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 letters, digits, periods (.), and hyphens (-).

The uniform resource identifier (URI) that is used 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 not start with a forward slash only.

The number of health checks that an unhealthy backend server must consecutively pass before it can be declared healthy. In this case, the health check state is changed from fail to success.

Valid values: 2 to 10.

The number of health checks that a healthy backend server must consecutively fail before it can be declared unhealthy. In this case, the health check state is changed from success to fail.

Valid values: 2 to 10.

The timeout period of a health check. Unit: seconds. If a backend server does not respond within the specified timeout period, the backend server fails the health check. This parameter takes effect only if 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 that is used for health checks.

Valid values: 1 to 65535.

The HTTP status code that indicates 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: yes
• off: no

The ID of the vServer group.

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

• on: yes
• off: no

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

• on: yes
• off: no

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

• on: yes
• off: no

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

• on: yes
• off: no

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

The type of ACL. Valid values:

• white: a whitelist. Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. The whitelist applies to scenarios in which you want to allow only specific IP addresses to access an application. Risks may arise if you specify an ACL as a whitelist. After a whitelist is configured, only IP addresses in the whitelist can access the CLB listener.

  If you enable a whitelist but the whitelist does not contain an IP address, the listener forwards all requests.

• black: a blacklist. All requests from the IP addresses or CIDR blocks in the ACL are blocked. The 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 blacklist does not contain an IP address, the listener forwards all requests.

Specifies whether to enable the access control feature. Valid values:

• on: yes
• off: no

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 another 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 specified timeout period, CLB sends an HTTP 504 error code to the client.

The description of the listener.

The ID of the request.