All Products
Search
Document Center

ENS:DescribeLoadBalancerHTTPSListenerAttribute

Last Updated:Oct 22, 2026

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

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

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: Enables the health check.

  • off: Disables the health check.

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:

  • http_2xx (default)

  • http_3xx

  • http_4xx

  • http_5xx

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:

  • head: Requests only the header of the page.

  • get: Requests the specified page information and returns the entity body.

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.

  • Default value: 5.

  • Valid values: 1 to 300.

  • Unit: seconds.

Note
  • This parameter takes effect only when HealthCheck is set to on.

  • If the value of HealthCheckTimeout is less than the value of HealthCheckInterval, HealthCheckTimeout is invalid and the timeout period is the value of HealthCheckInterval.

5

HealthCheckURI

string

The URI used for health checks. The URI must be 1 to 80 characters in length.

  • The URI cannot be only a forward slash (/), but must start with a forward slash.

  • This parameter takes effect only when HealthCheck is set to on.

/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:

  • on: Enables HTTP-to-HTTPS forwarding.

  • off: Disables HTTP-to-HTTPS forwarding.

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: Backend servers with higher weights are polled more frequently.

  • wlc: In addition to the weight of each backend server, the actual load (number of connections) of the backend server is also considered. If the weights are the same, backend servers with fewer current connections are polled more frequently.

  • rr: External requests are distributed to backend servers in sequence.

  • sch: Consistent hashing based on source IP addresses. Requests from the same source IP address are scheduled to the same backend server.

  • qch: Consistent hashing based on QUIC Connection IDs. Requests with the same QUIC Connection ID are scheduled to the same backend server.

  • iqch: Consistent hashing based on three specific bytes of the iQUIC CID. Requests with the same 2nd to 4th bytes are scheduled to the same backend server.

wrr

ServerCertificateId

string

The ID of the server certificate.

60276**

Status

string

The current status of the listener. Valid values:

  • Running: The listener is running normally.

  • Stopped: The listener is stopped.

  • Starting: The listener is starting.

  • Configuring: The listener is being configured.

  • Stopping: The listener is being stopped.

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.