Modifies the configurations of an HTTPS listener.
Operation description
- A Classic Load Balancer (CLB) instance is created. For more information, see CreateLoadBalancer .
- An HTTPS listener is created. For more information about how to create an HTTPS listener, see CreateLoadBalancerHTTPSListener .
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
slb:SetLoadBalancerHTTPSListenerAttribute | update |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | No | The ID of the region where the CLB instance is deployed. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
LoadBalancerId | string | Yes | The ID of the CLB instance. | lb-sjhfdji**** |
ListenerPort | integer | Yes | The frontend port that is used by the CLB instance. Valid values: 1 to 65535. | 80 |
Bandwidth | integer | No | The maximum bandwidth of the listener. Unit: Mbit/s. Valid values:
| -1 |
XForwardedFor | string | No | Specifies whether to use the
| on |
Scheduler | string | No | The scheduling algorithm. Valid values:
| wrr |
StickySession | string | No | Specifies whether to enable session persistence. Valid values:
| on |
StickySessionType | string | No | The method that is used to handle a cookie. Valid values:
Note
This parameter is required if the StickySession parameter is set to on.
| insert |
CookieTimeout | integer | No | The timeout period of the cookie. Unit: seconds. Valid values: 1 to 86400. Note
This parameter is required if the StickySession parameter is set to on and the StickySessionType parameter is set to insert.
| 500 |
Cookie | string | No | 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 ($). Note
This parameter is required when you set the StickySession parameter to on and the StickySessionType parameter to server.
| B490B5EBF6F3CD4**** |
HealthCheck | string | No | Specifies whether to enable health checks. Valid values:
| on |
HealthCheckMethod | string | No | The HTTP method that is used for health checks. Valid values: head and get. Note
This parameter takes effect only when the HealthCheck parameter is set to on.
| get |
HealthCheckDomain | string | No | The domain name that is used for health checks. Valid values:
Note
This parameter takes effect only when the HealthCheck parameter is set to on.
| 172.XX.XX.16 |
HealthCheckURI | string | No | 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 (/). Note
This parameter takes effect only when the HealthCheck parameter is set to on.
| /test/index.html |
HealthyThreshold | integer | No | 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. Note
This parameter takes effect only when the HealthCheck parameter is set to on.
| 4 |
UnhealthyThreshold | integer | No | 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. Note
This parameter takes effect only when the HealthCheck parameter is set to on.
| 4 |
HealthCheckTimeout | integer | No | 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. Note
This parameter takes effect only if the HealthCheck parameter is set to on.
| 3 |
HealthCheckInterval | integer | No | The interval between two consecutive health checks. Unit: seconds. Valid values: 1 to 50. Note
This parameter takes effect only when the HealthCheck parameter is set to on.
| 5 |
HealthCheckConnectPort | integer | No | The port that is used for health checks. Valid values: 1 to 65535. Note
This parameter takes effect only when the HealthCheck parameter is set to on.
| 8080 |
HealthCheckHttpCode | string | No | 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. Note
This parameter takes effect only when the HealthCheck parameter is set to on.
| http_2xx,http_3xx |
ServerCertificateId | string | No | The ID of the server certificate. | idkp-123-cn-te**** |
CACertificateId | string | No | The ID of the CA certificate.
| 139a00604ad-cn-east-**** |
VServerGroup | string | No | Specifies whether to use a vServer group. Valid values:
| on |
VServerGroupId | string | No | The ID of the vServer group. | rsp-cige6j**** |
XForwardedFor_SLBIP | string | No | Specifies whether to use the
| on |
XForwardedFor_SLBID | string | No | Specifies whether to use the
| on |
XForwardedFor_proto | string | No | Specifies whether to use the
| on |
Gzip | string | No | Specifies whether to enable
| on |
AclId | string | No | 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. | nacl-a2do9e413e0spzasx**** |
AclType | string | No | The type of network ACL. Valid values:
Note
This parameter takes effect only when AclStatus is set to on.
| white |
AclStatus | string | No | Specifies whether to enable access control. Valid values:
| off |
IdleTimeout | integer | 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. | 23 |
RequestTimeout | integer | No | 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. | 223 |
EnableHttp2 | string | No | Specifies whether to use
| off |
TLSCipherPolicy | string | 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_2 |
Description | string | No | 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 (_). | Listener1 |
XForwardedFor_SLBPORT | string | No | Specifies whether to use the
| off |
XForwardedFor_ClientSrcPort | string | No | Specifies whether to use the
| off |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | ParamDuplicateError | The specified parameter value of XForwardedFor_ClientCertSubjectDNAlias is duplicate. Please change to a different one. |
400 | ParamDuplicateError | The specified parameter value of XForwardedFor_ClientCertIssuerDNAlias is duplicate. Please change to a different one. |
400 | ParamDuplicateError | The specified parameter value of XForwardedFor_ClientCertFingerprintAlias is duplicate. Please change to a different one. |
400 | ParamDuplicateError | The specified parameter value of XForwardedFor_ClientCertClientVerifyAlias is duplicate. Please change to a different one. |
400 | IpVersionConflict | The ip version of this LoadBalancer and the Acl is conflict. |
400 | InvalidParameter.IdleTimeout | The specified IdleTimeout exceeds the limit. |
400 | InvalidParameter.RequestTimeout | The specified RequestTimeout exceeds the limit. |
400 | ListenerForwardNotSupport | X-Forward-For is not supported to a ipv6 instance. |
400 | InvalidParameter.RegionNotSupport | The region does not support the parameter: %s. |
400 | InvalidParameter.SpecNotSupport | The loadBalancer of shared spec does not support the parameter: %s. |
400 | OperationFailed.ServerGroupInUse | The VServerGroup or MasterSlaveServerGroup can not be close for this listener. |
400 | InvalidParameter.VServerGroupId | The MasterSlaveServerGroup can not be attached to HTTP or HTTPS listener. |
400 | MissingParam.HealthCheckDomain | The HealthCheckDomain is required when HealthCheckHttpVersion is http1.1. |
400 | InvalidParameter.HealthCheckHttpVersion | The param HealthCheckHttpVersion is invalid. |
400 | QuotaLimitExceeds.AclAttachedToListener | %s. |
400 | QuotaLimitExceeds.TotalAclEntry | %s. |
400 | AclListenerOverLimit | %s. |
400 | Duplicated.AclEntry | %s. |
400 | CertificateNotExist | The specified CertificateId does not exist. |
400 | InvalidTLSPolicyId.NotExist | The specified TLS cipher policy does not exist. |
400 | TLSPolicyConfiguring | The specified TLS cipher policy is configuring. |
400 | TLSCipherPolicyVipRelationOverLimit | The number of listeners associated with a policy has exceeded. |
400 | TooManyCertificates | The number of certificates must not be greater than one. |
400 | CertificateTypeMismatched | The certificate type does not match. |
400 | MissingParam.ServerCertificates | Server certificates are required. |
400 | CnCertificateNotSupport | The cn certificate is not support. |
400 | InvalidParam.CertificateBindingType | The param CertificateBindingType is invalid. |
400 | InvalidParamSize.ServerCertificates | The size of param ServerCertificates is invalid. |
400 | TooManyCertificates.ServerCertificates | The number of certificates must not be greater than one. |
404 | ResourceNotFound.Certificate | The specified resource is not found. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-12-14 | The Error code has changed. The request parameters of the API has changed | View Change Details |