All Products
Search
Document Center

ENS:DescribeLoadBalancerHTTPListenerAttribute

Last Updated:Mar 12, 2024

Queries the configuration of an HTTP listener.

Operation description

Note
  • You can call this operation up to 100 times per second per account.

  • You can call this operation up to 10 times per second per user.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ListenerPortintegerYes

The frontend port that is used by the Edge Load Balance (ELB) instance. Valid values: 1 to 65535.

8080
LoadBalancerIdstringYes

The ID of the ELB instance.

lb-5snthcyu1x10g7tywj7iu****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
ListenerPortinteger

The frontend port that is used by the ELB instance. Valid values: 1 to 65535.

8080
Statusstring

The status of the listener. Valid values:

  • Running
  • Stopped
  • Starting
  • Configuring
  • Stopping
Running
Bandwidthinteger

The maximum bandwidth of the EIP.

  • Default value: 5.
  • Valid values: 5 to 10000.
  • Unit: Mbit/s.
50
Schedulerstring

The routing algorithm. Valid values:

  • wrr: Backend servers with higher weights receive more requests than those with lower weights.
  • wlc: Requests are distributed based on the weight and load of each backend server. The load refers to the number of connections to a backend server. If two backend servers have the same weight, the backend server that has fewer connections receives more requests.
  • rr: Requests are distributed to backend servers in sequence.
  • sch: consistent hashing that is based on source IP addresses. Requests from the same source IP address are distributed to the same backend server.
  • qch: consistent hashing that is based on QUIC connection IDs. Requests that contain the same QUIC connection ID are distributed to the same backend server.
  • iqch: consistent hashing that is based on specific three bytes of the iQUIC CIDs. Requests whose second to fourth bytes are the same are distributed to the same backend server.
wrr
HealthCheckstring

Indicates whether the health check feature is enabled. Valid values:

  • on
  • off
on
HealthyThresholdinteger

The number of consecutive successful health checks that must occur before an unhealthy and inaccessible backend server is declared healthy and accessible. Valid values: 2 to 10.

Note This parameter is returned only if you set HealthCheck to on.
3
UnhealthyThresholdinteger

The number of consecutive failed health checks that must occur before a healthy and accessible backend server is declared unhealthy and inaccessible. Valid values: 2 to 10.

Note This parameter is returned only if you set HealthCheck to on.
3
HealthCheckTimeoutinteger

The timeout period of a health check. If a backend server does not respond within the specified timeout period, the server fails to pass the health check.

  • Default value: 5.
  • Valid values: 1 to 300.
  • Unit: seconds.
Note
  • This parameter is returned only if you set HealthCheck to on.

  • If the value of the HealthCheckTimeout parameter is smaller than the value of the HealthCheckInterval parameter, the timeout period specified by the HealthCheckTimeout parameter becomes invalid and the value of the HealthCheckInterval parameter is used as the timeout period.

10
HealthCheckConnectPortinteger

The port that is used for health checks. Valid values: 1 to 65535. If you leave this parameter empty, the port specified by BackendServerPort is used for health checks.

Note This parameter is returned only if you set HealthCheck to on.
5000
HealthCheckIntervalinteger

The interval at which health checks are performed. Valid values: 1 to 50. Unit: seconds.

Note This parameter is returned only if you set HealthCheck to on.
5
Descriptionstring

The description of the listener. The description must be 1 to 80 characters in length.

Note The value cannot start with http:// or https://.
abc
ListenerForwardstring

Indicates whether HTTP-to-HTTPS redirection is enabled. Valid values:

  • on: HTTP-to-HTTPS redirection is enabled.
  • off (default)
off
ForwardPortinteger

The listener port that is used to redirect HTTP requests to HTTPS.

10002
RequestTimeoutinteger

The timeout period of requests. Default value: 60. Valid values: 1 to 180. Unit: seconds.

Note If no response is received from the backend server within the specified timeout period, ELB returns an HTTP 504 error code to the client.
60
IdleTimeoutinteger

The timeout period for idle connections. Default value: 15. Valid values: 1 to 60. Unit: seconds.

Note If no request is received within the specified timeout period, ELB closes the connection. When another request is received, ELB establishes a new connection.
15
HealthCheckHttpCodestring

The HTTP status codes for a successful health check. Valid values:

  • http_2xx (default)
  • http_3xx.
  • http_4xx
  • http_5xx
Note This parameter is returned only if you set HealthCheck to on.
http_2xx
HealthCheckDomainstring

The domain name that is used for health checks.

Note This parameter is returned only if you set HealthCheck to on.
www.example.com
HealthCheckURIstring

The Uniform Resource Identifier (URI) that is used for health checks. The URI must be 1 to 80 characters in length.

Note
  • The URL must start with a forward slash (/) and contain characters other than forward slashes (/).

  • This parameter is returned only if you set HealthCheck to on.

/checkpreload.htm
ServerCertificateIdstring

The ID of the server certificate.

6027667
HealthCheckMethodstring

The health check method used in HTTP health checks. Valid values:

  • head: requests the head of the page.
  • get: requests the specified part of the page and returns the entity body.
Note This parameter is returned only if you set HealthCheck to on.
head

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "ListenerPort": 8080,
  "Status": "Running",
  "Bandwidth": 50,
  "Scheduler": "wrr",
  "HealthCheck": "on",
  "HealthyThreshold": 3,
  "UnhealthyThreshold": 3,
  "HealthCheckTimeout": 10,
  "HealthCheckConnectPort": 5000,
  "HealthCheckInterval": 5,
  "Description": "abc",
  "ListenerForward": "off",
  "ForwardPort": 10002,
  "RequestTimeout": 60,
  "IdleTimeout": 15,
  "HealthCheckHttpCode": "http_2xx",
  "HealthCheckDomain": "www.example.com",
  "HealthCheckURI": "/checkpreload.htm",
  "ServerCertificateId": "6027667",
  "HealthCheckMethod": "head"
}

Error codes

HTTP status codeError codeError message
400LoadBalancerNotFoundThe input parameter loadBalancerId that is not found.
400ens.interface.errorAn error occurred while call the API.
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history