Queries the configurations of an HTTPS listener.
Operation description
API call 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:DescribeLoadBalancerHTTPSListenerAttribute |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ListenerPort |
integer |
Yes |
The listener port to query. Valid values: 1 to 65535. |
443 |
| LoadBalancerId |
string |
Yes |
The ID of the load balancer instance. |
lb-5qoxu2rsr0ytanpn4r3i**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| BackendServerPort |
integer |
The port used by the backend server of the load balancer instance. Valid values: 1 to 65535. |
8080 |
| Bandwidth |
integer |
The peak bandwidth of the load balancer. Default value: -1, which indicates that bandwidth is not limited. |
50 |
| Description |
string |
The description of the listener. The description must be 1 to 80 characters in length. |
abc |
| ForwardPort |
integer |
The HTTP-to-HTTPS forwarding port for the listener. |
0 |
| HealthCheck |
string |
Specifies whether to enable the health check. Valid values:
|
on |
| HealthCheckConnectPort |
integer |
The port used for health checks. Valid values: 1 to 65535. If this parameter is not specified, the backend server port (BackendServerPort) is used. Note
This parameter takes effect only when HealthCheck is set to on. |
9902 |
| HealthCheckDomain |
string |
The domain name used for health checks. Note
This parameter takes effect only when HealthCheck is set to on. |
www.test.com |
| HealthCheckHttpCode |
string |
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 |
| HealthCheckInterval |
integer |
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. |
5 |
| HealthCheckMethod |
string |
The HTTP method used for health checks. Valid values:
Note
This parameter takes effect only when HealthCheck is set to on. |
head |
| HealthCheckTimeout |
integer |
The timeout period for receiving a response from a health check. If the backend ENS instance does not respond within the specified timeout period, the health check fails.
Note
|
5 |
| HealthCheckURI |
string |
The URI used for health checks. The URI must be 1 to 80 characters in length.
|
/checkpreload.htm |
| HealthyThreshold |
integer |
The number of consecutive successful health checks required to change the health check status of a backend server from fail (unreachable) to success (reachable). Valid values: 2 to 10. Note
This parameter takes effect only when HealthCheck is set to on. |
3 |
| IdleTimeout |
integer |
The idle connection timeout period. Default value: 15. Valid values: 1 to 60. Unit: seconds. Note
If no access request is received within the timeout period, the load balancer temporarily interrupts the current connection and establishes a new connection when the next request arrives. |
15 |
| ListenerForward |
string |
Specifies whether to enable HTTP-to-HTTPS forwarding. Valid values:
|
off |
| ListenerPort |
integer |
The frontend port used by the load balancer instance. Valid values: 1 to 65535. |
8080 |
| RequestId |
string |
The request ID. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| RequestTimeout |
integer |
The request timeout period. Default value: 60. Valid values: 1 to 180. Unit: seconds. Note
If no response is received from the backend server within the timeout period, the load balancer stops waiting and returns an HTTP 504 error code to the client. |
60 |
| Scheduler |
string |
The scheduling algorithm. Valid values:
|
wrr |
| ServerCertificateId |
string |
The ID of the server certificate. |
60276** |
| Status |
string |
The current status of the listener. Valid values:
|
Running |
| UnhealthyThreshold |
integer |
The number of consecutive failed health checks required to change the health check status of a backend server from success (reachable) to fail (unreachable). Valid values: 2 to 10. Note
This parameter takes effect only when HealthCheck is set to on. |
3 |
Examples
Success response
JSON format
{
"BackendServerPort": 8080,
"Bandwidth": 50,
"Description": "abc",
"ForwardPort": 0,
"HealthCheck": "on",
"HealthCheckConnectPort": 9902,
"HealthCheckDomain": "www.test.com",
"HealthCheckHttpCode": "http_2xx",
"HealthCheckInterval": 5,
"HealthCheckMethod": "head",
"HealthCheckTimeout": 5,
"HealthCheckURI": "/checkpreload.htm",
"HealthyThreshold": 3,
"IdleTimeout": 15,
"ListenerForward": "off",
"ListenerPort": 8080,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"RequestTimeout": 60,
"Scheduler": "wrr",
"ServerCertificateId": "60276**",
"Status": "Running",
"UnhealthyThreshold": 3
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | LoadBalancerNotFound | The input parameter loadBalancerId that is not found. | |
| 400 | ens.interface.error | An error occurred while call the API. | |
| 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.