CreateLoadBalancerHTTPListener

The operation that you want to perform.

Set the value to CreateLoadBalancerHTTPListener.

Specifies whether to enable health checks. Valid values:

• on: enables health checks.
• off: disables health checks.

The frontend port that is used by the CLB instance.

Valid values: 1 to 65535.

The ID of the CLB instance.

Specifies whether to enable session persistence. Valid values:

• on: yes
• off (default): no

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: specifies that the maximum bandwidth is unlimited.
• 1 to 5120: The sum of bandwidth values that you specify for all listeners of the CLB instance cannot exceed the maximum bandwidth of the CLB instance.

The backend port that is used by the CLB instance.

Valid values: 1 to 65535.

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

• on (default): yes
• off: no

The scheduling algorithm. Valid values:

• wrr (default): Backend servers with higher weights receive more requests than backend servers with lower weights.
• rr: Requests are distributed to backend servers in sequence.

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 that is sent to a client. The next request from the client will contain this cookie, and the listener will forward this request to the recorded backend server.

• server: rewrites a 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 the 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 that is configured on the backend server.

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

The health check method 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 do not set this parameter or set the parameter to $_ip, the CLB 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 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, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URI start with a forward slash (/) but cannot be a single forward slash (/).

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 response. If a backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the ECS instance is considered unhealthy. Unit: seconds.

Valid values: 1 to 300.

The backend port that is used for health checks.

Valid values: 1 to 65535.

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

Valid values: 1 to 50.

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

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

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 (default): no

Indicates whether the SLB-ID header is used to obtain the ID of the CLB instance. Valid values:

• on: yes
• off (default): no

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

• on: yes
• off (default): no

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

• on (default): yes
• off: no

The ID of the access control list (ACL) to be 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 network ACL are forwarded. Whitelists apply to scenarios where you want to allow only specific IP addresses to access an application. Risks may arise if the whitelist is improperly set. After a whitelist is configured, only IP addresses in the whitelist can access the CLB listener.

  If no IP address is added to the whitelist, the CLB listener forwards all requests.

• black: a blacklist. All requests from the IP addresses or CIDR blocks in the network ACL are denied. Blacklists apply to scenarios where you want to deny access from specified IP addresses to an application.

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

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

• on: yes
• off (default): no

The description of the listener.

The description must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.),and underscores (_).

Specifies whether to enable HTTP-to-HTTPS redirection. Valid values:

• on: yes
• off (default): no

The listener port that is used to redirect HTTP requests to HTTPS requests.

The timeout period of an idle connection. Unit: seconds.

Default value: 15. Valid values: 1 to 60.

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.

Default value: 60. Valid values: 1 to 180.

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 ID of the request.