public static final class SetLoadBalancerHTTPSListenerAttributeRequest.Builder extends Object
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder aclId(String aclId)
The ID of the network access control list (ACL) that is associated with the listener.
This parameter is required if AclStatus is set to on.
example:nacl-a2do9e413e0spzasx****
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder aclStatus(String aclStatus)
Specifies whether to enable access control. Valid values:
off
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder aclType(String aclType)
The type of 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 where you want to allow only specific IP addresses to access an application. Your business may be adversely affected if the whitelist is not set properly. 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 no IP address is added to the blacklist, the listener forwards all requests.
example:This parameter takes effect only when AclStatus is set to on.
white
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder bandwidth(Integer bandwidth)
The maximum bandwidth of the listener. Unit: Mbit/s.
Valid values:
-1
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder CACertificateId(String CACertificateId)
The ID of the CA certificate.
139a00604ad-cn-east-****
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder cookie(String cookie)
The cookie that you want to configure for 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 space characters. It cannot start with a dollar sign ($).
example:This parameter is required when you set the StickySession parameter to on and the StickySessionType parameter to server.
testCookie
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder cookieTimeout(Integer cookieTimeout)
The timeout period of the cookie. Unit: seconds.
Valid values: 1 to 86400.
example:This parameter is required if the StickySession parameter is set to on and the StickySessionType parameter is set to insert.
500
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder description(String description)
The description of the listener. The name must be 1 to 256 characters in length and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), and underscores (_).
example:https_80
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder dryRun(Boolean dryRun)
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder enableHttp2(String enableHttp2)
Specifies whether to use HTTP 2.0. Valid values:
off
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder gzip(String gzip)
Specifies whether to enable Gzip compression to compress specific types of files. Valid values:
on
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder healthCheck(String healthCheck)
Specifies whether to enable health checks. Valid values:
on
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder healthCheckConnectPort(Integer healthCheckConnectPort)
The port that is used for health checks.
Valid values: 1 to 65535.
example:This parameter takes effect only when the HealthCheck parameter is set to on.
8080
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder healthCheckDomain(String healthCheckDomain)
The domain name that is used for health checks. Valid values:
example:This parameter takes effect only when the HealthCheck parameter is set to on.
172.XX.XX.16
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder healthCheckHttpCode(String healthCheckHttpCode)
The HTTP status code of a successful health check. Separate multiple HTTP status codes with commas (,).
Valid values: http_2xx, http_3xx, http_4xx, and http_5xx.
example:This parameter takes effect only when the HealthCheck parameter is set to on.
http_2xx,http_3xx
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder healthCheckInterval(Integer healthCheckInterval)
The interval between two consecutive health checks. Unit: seconds.
Valid values: 1 to 50.
example:This parameter takes effect only when the HealthCheck parameter is set to on.
5
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder healthCheckMethod(String healthCheckMethod)
The HTTP method that is used for health checks. Valid values: head and get.
example:This parameter takes effect only when the HealthCheck parameter is set to on.
get
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder healthCheckTimeout(Integer healthCheckTimeout)
The timeout period of a health check response. If a backend ECS instance does not respond within the specified timeout period, the ECS instance fails the health check. Unit: seconds Valid values: 1 to 300.
example:This parameter takes effect only if the HealthCheck parameter is set to on.
3
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder healthCheckURI(String healthCheckURI)
The URL that is used for health checks.
The URL must be 1 to 80 characters in length and can contain letters, digits, and the following characters: - / . % ? # &. The URL must not be a single forward slash (/) but it must start with a forward slash (/).
example:This parameter takes effect only when the HealthCheck parameter is set to on.
/test/index.html
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder healthyThreshold(Integer healthyThreshold)
The number of health checks that an unhealthy backend server must consecutively pass before it can be declared healthy (from fail to success).
Valid values: 2 to 10.
example:This parameter takes effect only when the HealthCheck parameter is set to on.
4
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder idleTimeout(Integer idleTimeout)
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.
example:23
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder listenerPort(Integer listenerPort)
The frontend port that is used by the CLB instance.
Valid values: 1 to 65535.
This parameter is required.
example:80
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder loadBalancerId(String loadBalancerId)
The ID of the CLB instance.
This parameter is required.
example:lb-sjhfdji****
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder ownerAccount(String ownerAccount)
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder ownerId(Long ownerId)
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder regionId(String regionId)
The ID of the region where the CLB instance is deployed.
You can call the DescribeRegions operation to query the most recent region list.
example:cn-hangzhou
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder requestTimeout(Integer requestTimeout)
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 during the request timeout period, CLB sends an HTTP 504 error code to the client.
example:223
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder resourceOwnerAccount(String resourceOwnerAccount)
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder resourceOwnerId(Long resourceOwnerId)
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder scheduler(String scheduler)
The scheduling algorithm. Valid values:
wrr
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder serverCertificateId(String serverCertificateId)
The ID of the server certificate.
example:idkp-123-cn-te****
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder stickySession(String stickySession)
Specifies whether to enable session persistence. Valid values:
on
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder stickySessionType(String stickySessionType)
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 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 will contain the user-defined cookie, and the listener will distribute this request to the recorded backend server.
example:This parameter is required if the StickySession parameter is set to on.
insert
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder TLSCipherPolicy(String TLSCipherPolicy)
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
tls_cipher_policy_1_2
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder unhealthyThreshold(Integer unhealthyThreshold)
The number of health checks that a healthy backend server must consecutively fail before it can be declared unhealthy (from success to fail).
Valid values: 2 to 10.
example:This parameter takes effect only when the HealthCheck parameter is set to on.
4
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder vServerGroup(String vServerGroup)
Specifies whether to use a vServer group. Valid values:
on
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder vServerGroupId(String vServerGroupId)
The ID of the vServer group.
example:rsp-cige6j****
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder xForwardedFor(String xForwardedFor)
Specifies whether to use the X-Forwarded-For header to retrieve client IP addresses. Valid values:
on
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder xForwardedForClientSrcPort(String xForwardedForClientSrcPort)
Specifies whether to use the XForwardedFor_ClientSrcPort header to retrieve the client port. Valid values:
off
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder xForwardedForSLBID(String xForwardedForSLBID)
Specifies whether to use the SLB-ID header to retrieve the ID of the CLB instance. Valid values:
on
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder xForwardedForSLBIP(String xForwardedForSLBIP)
Specifies whether to use the SLB-IP header to obtain the virtual IP address (VIP) requested by the client. Valid values:
on
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder xForwardedForSLBPORT(String xForwardedForSLBPORT)
Specifies whether to use the XForwardedFor_SLBPORT header to retrieve the listener port of the CLB instance. Valid values:
off
public SetLoadBalancerHTTPSListenerAttributeRequest.Builder xForwardedForProto(String xForwardedForProto)
Specifies whether to use the X-Forwarded-Proto header to retrieve the listener protocol. Valid values:
on
public SetLoadBalancerHTTPSListenerAttributeRequest build()
Copyright © 2026. All rights reserved.