Use CreateLoadBalancerUDPListener to configure a UDP listener - ENS - Alibaba Cloud - ENS

To create a UDP listener, call CreateLoadBalancerUDPListener.

Operation description

API call rate: 100 calls per second.
Per-user call rate: 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:CreateLoadBalancerUDPListener

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The ID of the load balancer instance.	lb-5q73cv04zeyh43lh74lp4****
ListenerPort	integer	Yes	The listener port used to receive requests and forward them to backend servers. Valid values: 1 to 65535. Note For UDP listeners, ports 250, 4789, and 4790 are system-reserved and not available for use.	80
Description	string	No	The name of the listener. The name must be 1 to 80 characters long. Note The name cannot start with `http://` or `https://`.	example
Scheduler	string	No	The scheduling algorithm. Valid values: wrr (default): Weighted Round Robin. Backend servers with a higher weight receive more requests. wlc: Weighted Least Connections. Requests are distributed based on both the weight and the number of current connections of each backend server. If multiple backend servers have the same weight, the one with the fewest active connections receives the next request. rr: Round Robin. Requests are distributed to backend servers sequentially. sch: Source IP Hash. Requests from the same source IP address are routed to the same backend server. tch: Four-tuple Hash. Requests are routed to backend servers based on a hash of four values: source IP address, destination IP address, source port, and destination port. Flows with the same four values are routed to the same backend server. qch: QUIC Connection ID Hash. Requests with the same QUIC Connection ID are routed to the same backend server. iqch: A consistent hash algorithm for iQUIC Connection IDs. Flows with the same second, third, and fourth bytes in the iQUIC CID are routed to the same backend server.	wrr
HealthyThreshold	integer	No	The number of consecutive successful health checks required for a backend server to be considered healthy. Valid values: 2 to 10. Default value: 3.	4
UnhealthyThreshold	integer	No	The number of consecutive failed health checks required for a backend server to be considered unhealthy. Valid values: 2 to 10. Default value: 3.	4
HealthCheckConnectTimeout	integer	No	The maximum time to wait for a response to a health check. A health check fails if a backend ENS instance does not respond within this time. Default value: 5. Valid values: 1 to 300. Unit: seconds. Note If this timeout is shorter than the health check interval (`HealthCheckInterval`), the interval value is used for the timeout instead.	100
HealthCheckInterval	integer	No	The interval between health checks, in seconds. Valid values: 1 to 50. Default value: 2.	3
BackendServerPort	integer	No	The port used by the backend servers. Valid values: 1 to 65535.	8080
HealthCheckConnectPort	integer	No	The port used for health checks. Valid values: 1 to 65535. If you do not specify this parameter, the port specified by `BackendServerPort` is used.	8080
HealthCheckReq	string	No	The request string for UDP health checks. The string must be up to 64 characters long and contain only letters and digits.	hello
HealthCheckExp	string	No	The expected response string for UDP health checks. The string must be up to 64 characters long and contain only letters and digits.	ok
EipTransmit	string	No	Specifies whether EIP pass-through is enabled. Valid values: on: Enables EIP pass-through. off (default): Disables EIP pass-through.	on
EstablishedTimeout	integer	No	The timeout for established connections. Valid values: 10 to 900. Default value: 900. Unit: seconds.	500

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	06F00FBB-3D9E-4CCE-9D43-1A6946A75456

Examples

Success response

JSON format

{
  "RequestId": "06F00FBB-3D9E-4CCE-9D43-1A6946A75456"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	IncorrectInstanceStatus	The current status of the resource does not support this operation.	The current operation is not supported. The disk is being reset.
400	ens.interface.error	Failed to call API.
400	LoadBalancerNotFound	The input parameter LoadBalancerId that is not found.	The load balancing instance does not exist.
400	ListenerAlreadyExists	The listenerPort already exists.	Listener already exists
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.