SetLoadBalancerUDPListenerAttribute

Description

call SetLoadBalancerUDPListenerAttribute to modify the configuration of UDP protocol listening.

Request Method

POST

Request Path

/apsara/route/Slb/SetLoadBalancerUDPListenerAttribute

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
MaxConnection	BODY	integer	No	10	Maximum number of connections.
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-cige6****	virtual server group ID.
HealthCheckInterval	BODY	integer	No	5	time interval for health check. Value:1~50 seconds.
Description	BODY	string	No	test	set the description information of the listener.
UnhealthyThreshold	BODY	integer	No	4	after how many consecutive health checks have failed, determine the health check status of the back-end server from success to failure . value:2~10.
Scheduler	BODY	string	No	wrr	scheduling algorithm. Value: wrr: The higher the weight value, the higher the number of times (probability) of being polled. wlc: In addition to polling according to the weight value set by each back-end server, the actual load of the back-end server (that is, the number of connections) 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 backend 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 consistency hash of the quad (source IP, destination IP, source port and destination port), the same stream is 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. Description Only guaranteed 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. description if HealthCheckConnectTimeout the value is less than HealthCheckInterval, then HealthCheckConnectTimeout is invalid, the timeout period is HealthCheckInterval.
LoadBalancerId	BODY	string	Yes	lb-bp1rtfnodmywb43ecu4sf-c****	ID of the load balancing instance.
VServerGroup	BODY	string	No	on	whether to use virtual server groups. Value:on or off. description VserverGroup and MasterSlaveServerGroup only one value is allowed to be on.
version	BODY	string	No	2016-01-01	version of api
healthCheckExp	BODY	string	No	OK	UDP listens to the health check response string, only alphanumeric characters are allowed, and the maximum length is limited to 500 characters.
MasterSlaveServerGroup	BODY	string	No	on	whether to use the primary and standby server group. Value:on or off. VserverGroup and MasterSlaveServerGroup only one value is allowed to be on.
healthCheckReq	BODY	string	No	hello	UDP is allowed to contain only alphanumeric characters and the maximum length is limited to 500 characters.
HealthCheckConnectPort	BODY	integer	No	80	port used for health check. Value:1~65535.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
Bandwidth	BODY	integer	No	-1	The peak bandwidth of the monitor, in Mbps. Value:-1 or 1~5120. -1: for public network load balancing instances charged by traffic, you can set the peak bandwidth to -1, that is, the peak bandwidth is not limited. 1~5120: for public network load balancing instances charged by bandwidth, the bandwidth peak value of each monitor can be set, however, the sum of the peak bandwidth of all listeners cannot exceed the peak bandwidth of the instance. For more information, see shared instance bandwidth .
HealthyThreshold	BODY	integer	No	4	after how many consecutive successful health checks, determine the health check status of the back-end server from failure to success . value:2~10.
MasterSlaveServerGroupId	BODY	string	No	rsp-0bfuc****	primary and standby server group ID. description only one server group ID and primary/standby server group ID can be selected.
Tags	BODY	string	No	{"tagKey":"Key1","tagValue":"Value1"}	tag keys and values.

Return data

Name	Type	Sample value	Description
RequestId	string	CEF72CEB-54B6-4AE8-B225-F876FF7BA984	request ID.

Example

Successful Response example

{
 "RequestId":"CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

Failed Response example

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

}