DescribeLoadBalancerUDPListenerAttribute

Description

call the DescribeLoadBalancerUDPListenerAttribute to query the configuration of UDP listeners.

Request Method

POST

Request Path

/apsara/route/Slb/DescribeLoadBalancerUDPListenerAttribute

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.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
LoadBalancerId	BODY	string	Yes	lb-bp1rtfnodmywb43e****	load balancing instance ID.
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
Status	string	stopped	the current status of listening. Value:running or stopped. running: indicates that the listening is running normally. stopped: indicates that the listening operation is stopped.
MaxConnection	integer	10	Maximum number of connections.
ListenerPort	integer	80	the port used by the front end of the load balancing instance.
VServerGroupId	string	rsp-cige6j****	bound virtual server group ID.
HealthCheckInterval	integer	5	the interval of health check, in seconds.
Description	string	access control description.	access control description.
RequestId	string	365F4154-92F6-4AE4-92F8-7FF34B540710	request ID.
UnhealthyThreshold	integer	4	unhealthy check threshold.
Scheduler	string	wrr	scheduling algorithm. 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 backend server, also consider the actual load of the back-end server (I. e., the number of connections). 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 also higher. rr: distribute external requests to backend servers in sequence according to the access order.
HealthCheck	string	on	whether to turn on health check. Value:on or off.
HealthCheckConnectTimeout	integer	100	health check response timeout.
BackendServerPort	integer	53	the port used by the backend of the load balancing instance. Description If the back-end server group is a virtual server group, this parameter is not returned.
PersistenceTimeout	integer	0	session hold timeout.
HealthCheckConnectPort	integer	8080	health check port. description in HealthCheck value is on is valid.
HealthCheckReq	string	hello	UDP listens to the health check request string.
Bandwidth	integer	-1	The peak bandwidth of the monitor, in Mbps. Value: -1: for public network load balancing instances charged by traffic, the bandwidth peak value can be set to -1, that is, the bandwidth peak value is not limited. 1~5120: for a public network load balancing instance that is 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	integer	4	health check threshold.
HealthCheckExp	string	OK	UDP listens to the health check response string.
MasterSlaveServerGroupId	string	rsp-0bfucw****	the id of the bound primary and standby server group.

Example

Successful Response example

{
 "Status":"stopped",
 "MaxConnection":"10",
 "ListenerPort":"80",
 "VServerGroupId":"rsp-cige6j****",
 "HealthCheckInterval":"5",
 "Description":"access control description.",
 "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
 "UnhealthyThreshold":"4",
 "Scheduler":"wrr",
 "HealthCheck":"on",
 "HealthCheckConnectTimeout":"100",
 "BackendServerPort":"53",
 "PersistenceTimeout":"0",
 "HealthCheckConnectPort":"8080",
 "HealthCheckReq":"hello",
 "Bandwidth":"-1",
 "HealthyThreshold":"4",
 "HealthCheckExp":"OK",
 "MasterSlaveServerGroupId":"rsp-0bfucw****"
}

Failed Response example

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

}