CreateLoadBalancerUDPListener-阿里云帮助中心

Creates a UDP listener.

Operation description

UDP listeners of Classic Load Balancer (CLB) instances in a classic network cannot pass client IP addresses to backend servers.

Note

A newly created listener is in the stopped state. After a listener is created, you can call the StartLoadBalancerListener operation to enable the listener to forward traffic to backend servers.

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

slb:CreateLoadBalancerUDPListener

create

*acl

acs:slb:{#regionId}:{#accountId}:acl/{#aclId}

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

slb:tag
slb:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region where the CLB instance is deployed.	cn-hangzhou
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The key of the tag. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key must be 1 to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	TestKey
Value	string	No	The tag value. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag value cannot contain `http://` or `https://`.	TestValue
LoadBalancerId	string	Yes	The ID of the CLB instance.	lb-bp1ygod3yctvg1y7****
ListenerPort	integer	Yes	The frontend port used by the CLB instance. Valid values: 1 to 65535.	80
BackendServerPort	integer	No	The backend port used by the CLB instance. Valid values: 1 to 65535. If the VServerGroupId parameter is not set, this parameter is required.	80
Bandwidth	integer	Yes	The maximum bandwidth of the listener. Unit: Mbit/s. Valid values: -1: For a pay-by-data-transfer Internet-facing CLB instance, you can set this parameter to -1. This way, the bandwidth of the listener is unlimited.	-1
Scheduler	string	No	The scheduling algorithm. Valid values: wrr (default): Backend servers with higher weights receive more requests than those with lower weights. rr: Requests are distributed to backend servers in sequence. sch: specifies consistent hashing that is based on source IP addresses. Requests from the same source IP address are distributed to the same backend server. tch: specifies consistent hashing that is based on four factors: source IP address, destination IP address, source port, and destination port. Requests that contain the same information based on the four factors are distributed to the same backend server. qch: specifies consistent hashing that is based on QUIC connection IDs. Requests that contain the same QUIC connection ID are distributed to the same backend server. Only high-performance CLB instances support the sch, tch, and qch consistent hashing algorithms.	wrr
HealthyThreshold	integer	No	The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status is changed from fail to success. Valid values: 2 to 10	4
UnhealthyThreshold	integer	No	The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status is changed from success to fail. Valid values: 2 to 10	4
HealthCheckConnectTimeout	integer	No	The timeout period of a health check. If a backend server, such as an Elastic Compute Service (ECS) instance, does not respond to a probe packet within the specified timeout period, the server fails the health check. Unit: seconds Valid values: 1 to 300.	100
HealthCheckConnectPort	integer	No	The port that is used for health checks. Valid values: 1 to 65535. If this parameter is not set, the backend port specified by BackendServerPort is used for health checks.	80
healthCheckInterval	integer	No	The interval between two consecutive health checks. Unit: seconds. Valid values: 1 to 50.	3
healthCheckReq	string	No	The request string for UDP listener health checks. The string must be 1 to 64 characters in length and can contain only letters and digits.	hello
healthCheckExp	string	No	The response string for UDP listener health checks. The string must be 1 to 64 characters in length and can contain only letters and digits.	ok
VServerGroupId	string	No	The ID of the vServer group.	rsp-cige6j8****
MasterSlaveServerGroupId	string	No	The ID of the primary/secondary server group. Note You can set only one of the VServerGroupId and MasterSlaveServerGroupId parameters.	rsp-0bfucwu****
AclId	string	No	The ID of the network ACL that is associated with the listener. If AclStatus is set to on, this parameter is required.	acl-uf60jw***
AclType	string	No	The type of the network ACL. Valid values: white: a whitelist. Only requests from the IP addresses or CIDR blocks in the network ACL are forwarded. Whitelists apply to scenarios in which you want to allow only specific IP addresses to access an application. After a whitelist is configured, only IP addresses in the whitelist can access the CLB listener. Risks may arise if the whitelist is improperly set. If a whitelist is configured but no IP address is added to the whitelist, the listener forwards all requests. black: a blacklist. All requests from the IP addresses or CIDR blocks in the network ACL are blocked. Blacklists apply to scenarios in which you want to deny access from specific IP addresses to an application. If a blacklist is configured for a listener but no IP address is added to the blacklist, the listener forwards all requests. If AclStatus is set to on, this parameter is required.	white
AclStatus	string	No	Specifies whether to enable access control. Valid values: on: yes off (default): no	off
Description	string	No	The name of the listener. The name must be 1 to 256 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), and underscores (_).	udp_80
ProxyProtocolV2Enabled	boolean	No	Specifies whether to use the Proxy protocol to pass client IP addresses to backend servers. Valid values: true: yes false (default): no	false
HealthCheckSwitch	string	No	Specifies whether to enable the health check feature. Valid values: on (default): yes off: no	on

Response elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameterValue.SpecNotSupport	The loadBalancer of shared spec does not support the parameter value, %s.
400	OperationNotSupport.Acl	The cloud box instance does not support acl.
400	InvalidParameterValue.RegionNotSupport	The region does not support the parameter value, %s.
400	Abs.VServerGroupIdAndMasterSlaveServerGroupId.MissMatch	The parameters VServerGroupId or MasterSlaveServerGroupId miss match.
400	IpVersionConflict	The ip version of this LoadBalancer and the Acl is conflict.
400	InvalidParameterValue.ZoneNotSupport	The zone does not support the parameter value, %s.
400	ListenerProcessing	A previous configuration of the listener is pending,please try again later.
400	AclNotExist	Acl does not exist.
400	InvalidParameter.ListenerPortConflict	There is conflict listener port exists.
400	InvalidParam.VServerGroupId	The specified VServerGroupId is invalid.
400	MissingParam.HealthCheckConnectPort	The parameter HealthCheckConnectPort is required.
400	InvalidParam.ListenerPort	The specified ListenerPort is invalid.
400	InvalidParam.StartPort	The specified StartPort is invalid.
400	InvalidParamSize.PortRange	The size of param PortRange is invalid.
400	InvalidParam.EndPort	The specified EndPort is invalid.
400	Duplicated.AclEntry	%s.	%s
400	InvalidParameter.RegionNotSupport	The region does not support the parameter: %s.
400	LbNotSupportTcpssl	You cannot create a TCP SSL type listener for the specified load balancer.
400	LbSupportTcpsslOnly	The specified load balancer supports TCP SSL type listener only.
400	ListenerNotSupportRule	You cannot create a rule for the specified listener.	You cannot create a rule for the specified listener.
400	InvalidParamLength.HealthCheckExp	The length of the parameter HealthCheckReq is invalid.
400	InvalidParamLength.HealthCheckReq	The length of the parameter HealthCheckReq is invalid.
400	InvalidParam.HealthCheckReq	The param HealthCheckReq is invalid.
400	InvalidParam.HealthCheckExp	The param HealthCheckExp is invalid.
400	ResourceNotFound.VServerGroup	%s.
400	IllegalParam.FailoverThreshold	The parameter FailoverThreshold is illegal.
400	IllegalParam.FailoverStrategy	The parameter FailoverStrategy is illegal.
400	InvalidParameter.ZoneNotSupport	The zone does not support the parameter %s.
400	MasterSlaveServerConflict	The servers are conflict for MasterSlaveGroup.
400	VipNotSupportQuicVersion	The listener does not support the parameter of QuicVersion.
400	IllegalParam.HealthCheckType	The param of HealthCheckType is illegal.
400	MissingParam.HealthCheckMethod	The param of HealthCheckMethod is missing.
400	IllegalParam.HealthCheckMethod	The param of HealthCheckMethod is illegal.
400	IllegalParam.HealthCheck	The param of HealthCheck is illegal.
400	OperationDenied.SpecialListenerPortNotAllowed	The operation is not allowed because port 4789 is reserved by the system.
400	Mismatch.SlbSpecTypeAndListenerProtocol	The SlbSpecType and ListenerProtocol are mismatched.
400	OperationDenied.OnlyIpv4SlbSupport	The operation is not allowed because of OnlyIpv4SlbSupport.
400	OperationDenied.FullNatModeNotAllowed	The operation is not allowed because of FullNatModeNotAllowed.
400	SpecNotSupportParameter	The instance with share spec does not support FullNatEnabled parameter.
400	InvalidParam.TagValue	%s.
400	InvalidParam.TagKey	%s.
400	SizeLimitExceeded.Tag	%s.
400	MissingParam.TagKey	The param MissingParam.TagKey is missing.
400	AclListenerOverLimit	This acl has reached the limit of binding to listeners.
400	QuotaLimitExceeds.AclAttachedToListener	The number of Acl bound listeners has reached the quota limit
400	QuotaLimitExceeds.TotalAclEntry	The number of Acl entries has reached the quota limit.
400	QuotaLimitExceeds.AclListenerOverLimit	This acl has reached the limit of binding to listeners.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.