Server Load Balancer:CreateLoadBalancerHTTPSListener

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 operation that you want to perform. Set the value to CreateLoadBalancerHTTPSListener.

The ID of the CLB instance.

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

Valid values: -1 and 1 to 5120.

• -1: For a pay-by-data-transfer Internet-facing CLB instance, you can set this parameter to -1. This way, the bandwidth of the listener is unlimited.
• 1 to 5120: For a pay-by-bandwidth Internet-facing SLB instance, you can specify the bandwidth limit of each listener. The sum of bandwidth limits that you set for all listeners cannot exceed the bandwidth limit of the SLB instance.

The frontend port that is used by the CLB instance.

Valid values: 1 to 65535.

The backend port that is used by the CLB instance. Valid values: 1 to 65535.

If the VServerGroupId parameter is not set, this parameter is required.

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

• on: yes
• off: no

The scheduling algorithm. Valid values:

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

• 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 will contain this cookie, and the listener will distribute 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 carries the user-defined cookie, and the listener will distribute the request to the recorded backend server.

The timeout period of a cookie. Unit: seconds.

Valid values: 1 to 86400.

The cookie that is configured on the 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 space characters. It cannot start with a dollar sign ($).

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

• on: yes
• off: no

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 the HealthCheckDomain parameter or set the parameter to $_ip, the CLB instance uses the private IP address of each backend server for health checks.
• domain: The domain name must be 1 to 80 characters in length and can contain letters, digits, periods (.), and hyphens (-).

The 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 special 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 server, such as an Elastic Compute Service (ECS) instance, does not return a health check response within the specified timeout period, the server fails the health check. Unit: seconds.

Valid values: 1 to 300.

The port that is used for health checks.

Valid values: 1 to 65535.

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

Valid values: 1 to 50.

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.

The ID of the server certificate.

The ID of the server group.

The ID of the certification authority (CA) certificate.

If both the CA certificate and the server certificate are uploaded, mutual authentication is used.

If you upload only the server certificate, one-way authentication is used.

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

• on: yes
• off: no

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

• on: yes
• off: no

Specifies whether to use the X-Forwarded-Proto header to retrieve the listener protocol. 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 network access control list (ACL) that is associated with the listener.

The type of the network 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 in which you want to allow only specific IP addresses to access an application. Your service may be adversely affected if the allowlist is not properly configured. After 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 network ACL are denied. The blacklist applies to scenarios in which you want to deny access from specific IP addresses to an application.

  If a blacklist is configured for a listener but no IP address is added to the blacklist, the listener forwards all requests.

Specifies whether to enable access control. Valid values:

• on: yes
• off: no

The name of the listener.

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

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

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. Valid values: 1 to 180. Default value: 60. Unit: seconds.

If no response is received from a backend server within the specified timeout period, CLB returns the HTTP 504 status code to the client.

Specifies whether to enable HTTP/2. Valid values:

• on: yes
• off: no

The Transport Layer Security (TLS) security policy. Each security policy contains TLS protocol versions and cipher suites available for HTTPS.

• tls_cipher_policy_1_0:

  Supported TLS versions: TLS 1.0, TLS 1.1, and TLS 1.2

  Supported cipher suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA

• tls_cipher_policy_1_1:

  Supported TLS versions: TLS 1.1 and TLS 1.2

  Supported cipher suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA

• tls_cipher_policy_1_2

  Supported TLS version: TLS 1.2

  Supported cipher suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA

• tls_cipher_policy_1_2_strict

  Supported TLS version: TLS 1.2

  Supported cipher suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES128-SHA, and ECDHE-RSA-AES256-SHA

• tls_cipher_policy_1_2_strict_with_1_3

  Supported TLS versions: TLS 1.2 and TLS 1.3

  Supported cipher suites: TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_CCM_SHA256, TLS_AES_128_CCM_8_SHA256, ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-ECDSA-AES128-SHA, ECDHE-ECDSA-AES256-SHA, ECDHE-RSA-AES128-SHA, and ECDHE-RSA-AES256-SHA

The ID of the request.