Modifies the configurations of an HTTPS listener.
Debug
Use OpenAPI Explorer to perform debug operations and generate SDK code examples.
Request parameters
Parameter | Type | Required? | Example value | Description |
---|---|---|---|---|
Action | String | Yes | SetLoadBalancerHTTPSListenerAttribute |
The name of this action. Value: SetLoadBalancerHTTPSListenerAttribute |
ListenerPort | Integer | Yes | 80 |
The frontend port used by the SLB instance. Value range: 1 to 65535 |
LoadBalancerId | String | Yes | 139a00604ad-cn-east-hangzhou-01 |
The ID of the SLB instance. |
RegionId | String | Yes | cn-hangzhou |
The ID of the region to which the SLB instance belongs. To query the region ID, refer to the list ofregions and zones or call DescribeRegions. |
AclId | String | No | 56565 |
Optional. The ID of the access control list associated with the listener. If the value of the AclStatus parameter is on, this parameter is required. |
AclStatus | String | No | off |
Optional. Indicates whether to enable access control. Valid values: on | off |
AclType | String | No | white |
Optional. The access control method:
If the value of the AclStatus parameter is on, this parameter is required. |
Bandwidth | Integer | No | -1 |
Optional. The peak bandwidth of the listener. Value: 1 | 1-5120
|
CACertificateId | String | No | 139a00604ad-cn-east-hangzhou-01 |
Optional. The ID of the CA certificate. If both the CA certificate and the server certificate are uploaded, mutual authentication is established. If only the server certificate is uploaded, one-way authentication is established. |
Cookie | String | No | B490B5EBF6F3CD402E515D22BCDA1598 |
Optional. The cookie configured on the backend server. The cookie must be 1 to 200 characters in length and can only contain ASCII English letters and numbers. It cannot contain commas (,), semicolons (;), or spaces, nor can it begin with $. If the value of StickySession is on and the value of StickySessionType is server, this parameter is required. |
CookieTimeout | Integer | No | 500 |
Optional. Timeout period of the cookie. Value range: 1 to 86400. Unit: seconds Note This parameter is required when the value of StickySession is on and the value of StickySessionType is insert.
|
Description | String | No | A description of the listener |
Optional. A description of the listener. |
EnableHttp2 | String | No | off |
Optional. Indicates whether to enable the HTTP/2 feature. Valid values: on | off |
Gzip | String | No | on |
Optional. Indicates whether to enable Gzip compression to compress a specific file type. Valid value: on | off. Default value: off |
HealthCheck | String | No | on |
Optional. Indicates whether to enable the health check function. Valid values: on | off |
HealthCheckConnectPort | Integer | No | 8080 |
Optional. The port used for health checks. Value range: 1 to 65535 |
HealthCheckDomain | String | No | $_ip |
Optional. The domain name used for health checks. Valid values:
|
HealthCheckHttpCode | String | No | http_2xx,http_3xx |
Optional. The HTTP status code indicating that the health check is normal. Separate multiple HTTP status codes by commas (,). Valid values: http_2xx | http_3xx | http_4xx | http_5xx |
HealthCheckInterval | Integer | No | 5 |
Optional. The time interval between two consecutive health checks. Value range: 1 to 50. Unit: seconds |
HealthCheckTimeout | Integer | No | 3 |
Optional. The length of time to wait for the response from the health check. If the backend ECS instance does not send a correct response within the specified time, the health check fails. Value range: 1 to 300. Unit: seconds Note If the value of HealthCheckTimeout is smaller than that of HealthCheckInterval, the parameter HealthCheckTimeout is invalid, and the timeout is set to the value of HealthCheckInterval.
|
HealthCheckURI | String | No | /test/index.html |
Optional. The URI used for health checks. |
HealthyThreshold | Integer | No | 4 |
Optional. The number of consecutive successes of health checks before a backend server is declared as healthy (from failure to success). Value range: 2 to 10 |
IdleTimeout | Integer | No | 23 |
Optional. The idle connection timeout. Value range: 1 to 60. Default value: 15. Unit: seconds If no request is received during the specified timeout period, SLB temporarily terminates the connection and restarts the connection when the next request is received. |
RequestTimeout | Integer | No | 223 |
Optional. The request timeout. Value range: 1 to 180. Default value: 60. Unit: seconds. If no response is received from the backend server during the specified timeout period, SLB stops waiting and sends an HTTP 504 error to the client. |
Scheduler | String | No | wrr |
Optional. The algorithm used to distribute traffic. Valid values:
|
ServerCertificateId | String | No | idkp-123-cn-test-01 |
Optional. The ID of the server certificate. |
StickySession | String | No | on |
Optional. Indicates whether to enable session persistence. Valid values: on | off |
StickySessionType | String | No | on |
Optional. The method used to handle the cookie. Valid values:
Note If the value of StickySession is on, this parameter is required.
|
TLSCipherPolicy | String | No | tls_cipher_policy_1_2 |
You can only specify the TLSCipherPolicy parameter for guaranteed-performance instances. Each security policy includes the TLS protocol versions that can be selected by HTTPS and the supported cipher suites. Currently, the following four security policies are supported:
|
UnhealthyThreshold | Integer | No | 4 |
Optional. The number of consecutive failures of health checks before a backend server is declared as unhealthy (from success to failure). Value range: 2 to 10 |
VServerGroup | String | No | on |
Optional. Indicates whether to use an active/standby server group. Valid values: on | off |
VServerGroupId | String | No | rsp-cige6j5e7p |
Optional. The ID of the VServer group. |
XForwardedFor | String | No | on |
Optional. Indicates whether to use the X-Forwarded-For header field to obtain the real IP address of a client. Valid values: on | off |
XForwardedFor_SLBID | String | No | on |
Optional. Indicates whether to use the Valid value: on | off. Default value: off |
XForwardedFor_SLBIP | String | No | on |
Optional. Indicates whether to use the Valid value: on | off. Default value: off |
XForwardedFor_proto | String | No | on |
Optional. Indicates whether to use the Valid values: on | off. Default value: off |
Response parameters
Parameter | Type | Example value | Description |
---|---|---|---|
RequestId | String | CEF72CEB-54B6-4AE8-B225-F876FF7BA984 |
The ID of the request. |
Examples
Request example
http(s)://[Endpoint]/? Action=SetLoadBalancerHTTPSListenerAttribute
&ListenerPort=80
&LoadBalancerId=139a00604ad-cn-east-hangzhou-01
&<CommonParameters>
Response examples
XML
format
<SetLoadBalancerHTTPSListenerAttributeResponse>
<RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
</SetLoadBalancerHTTPSListenerAttributeResponse>
JSON
format
{
"RequestId":" CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}