DescribeLoadBalancerTCPListenerAttribute - ENS - Alibaba Cloud Documentation Center

Queries the configurations of a Transmission Control Protocol (TCP) listener.

Operation description

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ens:DescribeLoadBalancerTCPListenerAttribute	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ListenerPort	integer	Yes	The frontend port that is used by the Edge Load Balance (ELB) instance. Valid values: 1 to 65535.	80
LoadBalancerId	string	Yes	The ID of the ELB instance.	lb-5snthcyu1x10g7tywj7iu****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
ListenerPort	integer	The frontend port that is used by the ELB instance.	80
Status	string	The status of the listener. Valid values: Running Stopped Starting Configuring Stopping	Stopped
Bandwidth	integer	The maximum bandwidth of the elastic IP address (EIP). Default value: 5. Valid values: 5 to 10000. Unit: Mbit/s.	5
Scheduler	string	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
PersistenceTimeout	integer	The timeout period of session persistence. Default value: 0. If the default value is used, the system disables session persistence. Valid values: 0 to 3600. Unit: seconds.	0
EstablishedTimeout	integer	The timeout period of a connection. Valid values: 10 to 900. Unit: seconds.	500
HealthCheck	string	Indicates whether the health check feature is enabled. Valid values: on off	on
HealthyThreshold	integer	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.	4
UnhealthyThreshold	integer	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.	4
HealthCheckConnectTimeout	integer	The timeout period of a health check response. 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 HealthCheckConnectTimeout parameter is smaller than that of the HealthCheckInterval parameter, the timeout period specified by the HealthCheckConnectTimeout parameter becomes invalid and the value of the HealthCheckInterval parameter is used as the timeout period.	100
HealthCheckInterval	integer	The interval at which health checks are performed. Valid values: 1 to 50. Unit: seconds.	5
Description	string	The description of the listener.	example
HealthCheckHttpCode	string	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
HealthCheckDomain	string	The domain name that is used for health checks. Note This parameter is returned only if you set HealthCheck to on.	example.com
HealthCheckURI	string	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.	/example/index.html
HealthCheckType	string	The type of health checks. Valid values: tcp (default) http	tcp
BackendServerPort	integer	The backend port that is used by the ELB instance. Valid values: 1 to 65535.	8080
HealthCheckConnectPort	integer	The port that is used for health checks. Valid values: 1 to 65535. If an empty string is returned for this parameter, the port specified by BackendServerPort is used for health checks. Note This parameter is returned only if you set HealthCheck to on.	8000
EipTransmit	string	Indicates whether EIP pass-through is enabled. Valid values: on off (default)	on

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "ListenerPort": 80,
  "Status": "Stopped",
  "Bandwidth": 5,
  "Scheduler": "wrr",
  "PersistenceTimeout": 0,
  "EstablishedTimeout": 500,
  "HealthCheck": "on",
  "HealthyThreshold": 4,
  "UnhealthyThreshold": 4,
  "HealthCheckConnectTimeout": 100,
  "HealthCheckInterval": 5,
  "Description": "example",
  "HealthCheckHttpCode": "http_2xx",
  "HealthCheckDomain": "example.com",
  "HealthCheckURI": "/example/index.html",
  "HealthCheckType": "tcp",
  "BackendServerPort": 8080,
  "HealthCheckConnectPort": 8000,
  "EipTransmit": "on"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ens.interface.error	An error occurred while call the API.	-
400	LoadBalancerNotFound	The input parameter loadBalancerId that is not found.	-
400	ListenerNotFound	Listener is not found.	Listener does not exist
400	NoPermission	Permission denied.	-
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	-

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

Change history

Change time	Summary of changes	Operation
2024-06-04	The Error code has changed	View Change Details