Use DescribeLoadBalancerUDPListenerAttribute to query UDP listener configuration - ENS - Alibaba Cloud - ENS

Call DescribeLoadBalancerUDPListenerAttribute to get a UDP listener's configuration.

Operation description

API rate limit: 100 requests per second (RPS).
Per-user rate limit: 10 RPS.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ListenerPort	integer	Yes	The listener port to query. Valid values: 1 to 65535.	80
LoadBalancerId	string	Yes	The ID of the load balancer.	lb-5pzipr2fszqtl2xf64uy5****

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	5D7597CF-1630-54EC-A945-624A33F2E7E8
ListenerPort	integer	The listener port.	80
Status	string	The status of the listener. Valid values: Running: The listener is running. Stopped: The listener is stopped. Starting: The listener is starting. Configuring: The listener is being configured. Stopping: The listener is being stopped.	Stopped
Bandwidth	integer	The peak bandwidth of the load balancer. A value of -1 indicates that no rate limit is applied.	5
Scheduler	string	The scheduling algorithm. Valid values: wrr (Weighted Round Robin): Backend servers with higher weights receive a larger proportion of requests. wlc (Weighted Least Connections): Requests are distributed based on both the weight and the current connection count of each backend server. If backend servers have the same weight, the server with the fewest connections receives more new requests. rr (Round Robin): Requests are distributed to backend servers sequentially. sch (Source IP Hash): Routes requests from the same source IP address to the same backend server by using a consistent hash of the source IP address. tch (4-tuple Hash): Routes packets from the same flow to the same backend server by using a consistent hash of the 4-tuple (source IP address, destination IP address, source port, and destination port). qch (QUIC Connection ID Hash): Uses a consistent hashing algorithm on the QUIC Connection ID to ensure that requests with the same connection ID are always routed to the same backend server. iqch (iQUIC CID Hash): Uses a consistent hashing algorithm on bytes 2, 3, and 4 of the iQUIC CID. Requests where these three bytes are the same are routed to the same backend server.	wrr
HealthCheck	string	Specifies whether to enable health checks. Valid values: on: Enabled. off: Disabled.	on
HealthyThreshold	integer	The number of consecutive successful health checks that must occur before a backend server can be declared healthy. Valid values: 2 to 10. Note This parameter takes effect only when `HealthCheck` is set to `on`.	4
UnhealthyThreshold	integer	The number of consecutive failed health checks that must occur before a backend server can be declared unhealthy. Valid values: 2 to 10. Note This parameter takes effect only when `HealthCheck` is set to `on`.	4
HealthCheckConnectTimeout	integer	The timeout period for a health check response. If a 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 `HealthCheckConnectTimeout` is less than the value of `HealthCheckInterval`, the value of `HealthCheckInterval` is used as the timeout period.	100
HealthCheckInterval	integer	The interval between health checks. Valid values: 1 to 50. Unit: seconds. Note This parameter takes effect only when `HealthCheck` is set to `on`.	5
Description	string	The listener name.	example
BackendServerPort	integer	The port used by the backend servers. Valid values: 1 to 65535.	8080
HealthCheckConnectPort	integer	The port used for health checks. Valid values: 1 to 65535. If you do not specify this parameter, the value of `BackendServerPort` is used.	8000
HealthCheckReq	string	The request string for UDP health checks. The string can contain only letters and digits and can be up to 64 characters in length.	hello
HealthCheckExp	string	The response string for UDP health checks. The string can contain only letters and digits and can be up to 64 characters in length.	ok
EipTransmit	string	Specifies whether to enable EIP passthrough. Valid values: on: Enabled. off (default): Disabled.	on
EstablishedTimeout	integer	The connection timeout period. Valid values: 10 to 900. Unit: seconds.	500

Examples

Success response

JSON format

{
  "RequestId": "5D7597CF-1630-54EC-A945-624A33F2E7E8",
  "ListenerPort": 80,
  "Status": "Stopped",
  "Bandwidth": 5,
  "Scheduler": "wrr",
  "HealthCheck": "on",
  "HealthyThreshold": 4,
  "UnhealthyThreshold": 4,
  "HealthCheckConnectTimeout": 100,
  "HealthCheckInterval": 5,
  "Description": "example",
  "BackendServerPort": 8080,
  "HealthCheckConnectPort": 8000,
  "HealthCheckReq": "hello",
  "HealthCheckExp": "ok",
  "EipTransmit": "on",
  "EstablishedTimeout": 500
}

Error codes

HTTP status code	Error code	Error message	Description
400	ListenerNotFound	Listener is not found.	Listener does not exist
400	LoadBalancerNotFound	The input parameter LoadBalancerId that is not found.	The load balancing instance does not exist.
400	ens.interface.error	Failed to call 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.