CreateLoadBalancerUDPListener

Description

call CreateLoadBalancerUDPListener to create UDP listener.

Request Method

POST

Request Path

/apsara/route/Slb/CreateLoadBalancerUDPListener

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
ListenerPort	BODY	integer	Yes	80	the port used by the front end of the load balancing instance. Value: 1~65535.
VServerGroupId	BODY	string	No	rsp-cige6j****8	server group ID.
Description	BODY	string	No	test	set the description information of the listener. is limited to 1-80 characters in length, including Chinese and English characters, numbers, dashes (-), forward slashes (/), underscores (_), and half-width periods (.).
UnhealthyThreshold	BODY	integer	No	4	after how many consecutive health checks have failed, the health check status of the backend server is determined from success to failure . Value: 2~10.
Scheduler	BODY	string	No	wrr	scheduling algorithm. Value: wrr (default value): the backend server with the higher the weight value, the higher the number of times (probability) it is polled. wlc: in addition to polling according to the weight value set by each back-end server, the actual load (that is, the number of connections) of the back-end server is also considered. When the weight value is the same, the number of times (probability) that the backend server with the smaller the current number of connections is polled is higher. rr: distribute external requests to back-end servers in sequence according to the access order. sch: based on the consistent hash of the source IP address, the same source address will be scheduled to the same backend server. tch: based on the consistent hash of the quad (source IP, destination IP, source port and destination port), the same stream will be scheduled to the same backend server. qch: based on QUIC Connection ID consistency hash, the same QUIC Connection ID will be scheduled to the same backend server. shows that only guaranteed-performance instances support sch, tch, and qch consistent hash algorithms.
HealthCheckConnectTimeout	BODY	integer	No	100	the time to wait to receive the response from the health check. If the backend ECS does not respond correctly within the specified time, the health check is determined to have failed. Value: 1~300 seconds.
LoadBalancerId	BODY	string	Yes	lb-bp1ygod3yctvg1y7****	load balancing instance ID.
BackendServerPort	BODY	integer	No	80	the port used by the backend of the load balancing instance, with the value of 1~65535. If the server group is not used (VServerGroupId is not specified), this parameter is required.
version	BODY	string	No	2016-01-01	version of api
healthCheckExp	BODY	string	No	OK	UDP listens to the health check response string, which is 1-500 characters long and supports only letters and numbers.
healthCheckInterval	BODY	integer	No	3	time interval for health check. Value: 1~50 seconds.
healthCheckReq	BODY	string	No	hello	UDP listens to the health check request string, which is 1 to 500 characters long and supports only letters and numbers.
HealthCheckConnectPort	BODY	integer	No	80	port used for health check. Valid values: 1~65535. when this parameter is not set, the back-end service port is used.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
Bandwidth	BODY	integer	Yes	34	The peak bandwidth of the monitor, in Mbps. Value: -1: for public network load balancing instances billed by traffic, the peak bandwidth can be set to -1, that is, the bandwidth peak is not limited. 1 ~ 5120: for public network load balancing instances that are billed by bandwidth, you can set the peak bandwidth of each listener, but the sum of the peak bandwidth of all listeners cannot exceed the peak bandwidth of the instance.
HealthyThreshold	BODY	integer	No	4	after how many consecutive successful health checks, the health check status of the backend server is determined from failure to success . Value: 2~10.
MasterSlaveServerGroupId	BODY	string	No	rsp-0bfucwu****	primary and standby server group ID. description only one server group ID and primary/standby server group ID can be selected.

Return data

Name	Type	Sample value	Description
RequestID	string	1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC	Request id

Example

Successful Response example

{
 "RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}