Modifies the configurations of an HTTPS listener.
Operation description
API rate limit: 100 calls per second.
Rate limit per user: 10 calls per second.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ens:SetLoadBalancerHTTPSListenerAttribute |
update |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| LoadBalancerId |
string |
Yes |
The ID of the load balancing instance. |
lb-5snthcyu1x10g7tywj7iu**** |
| ListenerPort |
integer |
Yes |
The frontend port of the listener whose attributes you want to modify. Valid values: 1 to 65535. |
10002 |
| Description |
string |
No |
The name of the listener. The name must be 1 to 80 characters in length. Note
It cannot start with |
Listener description |
| Scheduler |
string |
No |
The scheduling algorithm. Valid values:
Valid values:
|
wrr |
| HealthCheck |
string |
No |
Specifies whether to enable the health check. Valid values:
|
on |
| HealthCheckDomain |
string |
No |
The domain name used for health checks. Note
This parameter takes effect only when HealthCheck is set to on. |
www.example.com |
| HealthCheckURI |
string |
No |
The URI used for health checks. The URI must be 1 to 80 characters in length. Note
|
/checkpreload.htm |
| HealthyThreshold |
integer |
No |
The number of consecutive successful health checks that must occur before the health check status of a backend server changes from fail (unreachable) to success (reachable). Valid values: 2 to 10. Note
This parameter takes effect only when HealthCheck is set to on. |
3 |
| UnhealthyThreshold |
integer |
No |
The number of consecutive failed health checks that must occur before the health check status of a backend server changes from success (reachable) to fail (unreachable). Valid values: 2 to 10. Note
This parameter takes effect only when HealthCheck is set to on. |
3 |
| HealthCheckTimeout |
integer |
No |
The timeout period for a health check response. If a backend server does not respond within the specified timeout period, the health check fails.
Note
|
9 |
| HealthCheckConnectPort |
integer |
No |
The port used for health checks. Valid values: 1 to 65535. If the Settings for this parameter are not specified, the backend service port (BackendServerPort) is used. Note
This parameter takes effect only when HealthCheck is set to on. |
7001 |
| HealthCheckInterval |
integer |
No |
The interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. Note
This parameter takes effect only when HealthCheck is set to on. |
2 |
| HealthCheckHttpCode |
string |
No |
The HTTP status codes that indicate a successful health check. Valid values:
Note
This parameter takes effect only when HealthCheck is set to on. |
http_2xx |
| IdleTimeout |
integer |
No |
The idle connection timeout period. Default value: 15. Valid values: 1 to 60. Unit: seconds. Note
If there is no access request within the timeout period, load balancing temporarily breaks the current connection until a new connection is established when the next request arrives. |
15 |
| RequestTimeout |
integer |
No |
The request timeout period. Default value: 60. Valid values: 1 to 180. Unit: seconds. Note
If a backend server does not send a response within the timeout period, load balancing stops waiting and returns an HTTP 504 error code to the client. |
60 |
| ServerCertificateId |
string |
No |
The ID of the server certificate. |
6027667 |
| HealthCheckMethod |
string |
No |
The HTTP method used for health checks. Valid values:
Note
This parameter takes effect only when HealthCheck is set to on. Valid values:
|
get |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The ID of the request. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
Examples
Success response
JSON format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | ens.interface.error | An error occurred while call the API. | |
| 400 | Invalid%s | The specified parameter %s is invalid. | |
| 400 | Missing%s | You must specify the parameter %s. | |
| 400 | LoadBalancerNotFound | The input parameter loadBalancerId that is not found. | |
| 400 | ListenerNotFound | The input parameter listener that is not found. | |
| 400 | IncorrectListenerStatus | The current status of the resource does not support this operation. | The listener status is incorrect. |
| 400 | ServerCertificateNotFound | The input parameter serverCertificateId that is not found. | |
| 400 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | The current operation is not supported. The disk is being reset. |
| 400 | NoPermission | Permission denied. | |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.