DescribeLoadBalancerUDPListenerAttribute

Last Updated: Jul 03, 2017

Description

  • Queries UDP Listener information.

  • Listeners have 5 statuses: starting, running, configuring, stopping, and stopped. For the listener status transition chart and descriptions of each status, refer to the appendix Server Load Balancer Listener Status Transition Chart.

Request Parameters

Name Type Required? Description
Action String Yes Operator interface name, required parameter.
Value:DescribeLoadBalancerUDPListenerAttribute
LoadBalancerId String Yes Unique ID of an Server Load Balancer instance.
ListenerPort Integer Yes Server Load Balancer instance’s frontend port.
Value:1-65535

Return Parameters

Name Type Description
Public Return Parameters For details, see Common parameters
ListenerPort Integer Server Load Balancer instance’s frontend port, range: 1-65535.
BackendServerPort Integer Server Load Balancer instance’s backend port, range: 1-65535.
Bandwidth Integer Listener’s peak bandwidth, range: 1-1000Mbps.
Status String Current listener status. There are 5 statuses: starting, running, configuring, stopping, and stopped.
Scheduler String Scheduling algorithm. wrr or wlc.
PersistenceTimeout Integer Connection persistence timeout time. 0 indicates disabled.
StickySessionType String Cookie processing method. When set to insert, this indicates it is inserted by the Server Load Balancer. When set to server, this indicates the Server Load Balancer learns from the backend server.
HealthCheck String Whether or not health checks are enabled. On enables health checks and Off disables them.
HealthyThreshold Integer Number of successive successful health checks to change the backend server’s status from Fail to Success.
UnhealthyThreshold Integer Number of successive failed health checks to change the backend server’s status from Success to Fail.
HealthCheckConnectTimeout Integer Health check connection timeout time.
HealthCheckConnectPort Integer Port used for health checks.
HealthCheckInterval Integer Interval between health checks, in seconds.
VServerGroupId String Virtual server group ID being bound.
MasterSlaveServerGroupId String Master-slave server group ID being bound.

Example

Request Example

  1. https://slb.aliyuncs.com/
  2. &Action=DescribeLoadBalancerUDPListenerAttribute
  3. &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
  4. &ListenerPort=53
  5. &<Public Request Parameters>

Return Example

  • XML format
    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <DescribeLoadBalancerUDPListenerAttributeResponse>
    3. <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    4. <ListenerPort>53</ListenerPort>
    5. <BackendServerPort>53</BackendServerPort>
    6. <Bandwidth>-1</Bandwidth>
    7. <Status>stopped</Status>
    8. <Schedule>wrr</Schedule>
    9. <StickySession>on</StickySession>
    10. <PersistenceTimeout>0</PersistenceTimeout>
    11. </DescribeLoadBalancerUDPListenerAttributeResponse>
  • JSON format
    1. {
    2. "RequestId":"365F4154-92F6-4AE4-92F8-7FF34B540710",
    3. "ListenerPort":53,
    4. "BackendServerPort":53,
    5. "Bandwidth":-1,
    6. "Status":"stopped",
    7. "Schedule":"wrr",
    8. "StickySession":"on",
    9. "PersistenceTimeout":0
    10. }
Thank you! We've received your feedback.