edit-icon download-icon

DescribeLoadBalancerUDPListenerAttribute

Last Updated: Apr 16, 2018

Description

Query the configurations of a specified UDP listener.

Request parameter

Name Type Required Description
Action String Yes

The action to perform. Valid value:

DescribeLoadBalancerUDPListenerAttribute

RegionId String Yes The ID of the region where the SLB instance is located.
LoadBalancerId String Yes The ID of the SLB instance for which the TCP listener is created.
ListenerPort Integer Yes

The front-end port of the listener that is used to receive incoming traffic and distribute the traffic to the backend servers.

Valid value: [1, 65535]

Response parameter

Name Type Description
RequestId String The ID of the request.
ListenerPort Integer The front-end port of the listener that is used to receive incoming traffic and distribute the traffic to the backend servers.
Status String The status of the listener.
BackendServerPort Integer The port opened on the backend server to receive requests.
Bandwidth Integer

The peak bandwidth of the listener. Valid value: [1,1000] Mbps

Note: If the value is set to -1, the Internet SLB instance is not limited by the bandwidth.

Scheduler String

The algorithm used to distribute traffic. Valid value:

  • wrr (Default)

    Backend servers with higher weights receive more requests than those with smaller weights.

  • wlc

    A server with a higher weight will receive a larger percentage of live connections at any one time. If the weights are the same, the system directs network connections to the server with the fewest established connections.

  • rr

    Requests are evenly and sequentially distributed to the backend servers.

VServerGroupId String The ID of a VServer group.
MasterSlaveServerGroupId String The ID of a master-slave server group.
HealthCheckConnectPort Integer The port used for health check.
HealthyThreshold Integer The number of consecutive successes of health check performed by the same LVS mode server on the same ECS instance (from failure to success).
UnhealthyThreshold Integer The number of consecutive failures of health check performed by the same LVS node server on the same ECS instance (from success to failure).
HealthCheckConnectTimeout Integer

The amount of time in seconds to wait for the response from a health check. If an ECS instance sends no response within the specified timeout period, the health check fails.

Note: If the value of the HealthCheckInterval is greater than the value of the HealthCHeckTimeout parameter, the timeout is set to the value of the HealthCheckInterval parameter.

HealthCheckInterval Integer The time interval between two consecutive health checks.
HealthCheckReq String Request string for UDP listener health check. Only English letters, digits are allowed. Up to 500 characters can be entered.
HealthCheckExp String Response string for UDP listener check. Only English letters, digits are allowed. Up to 500 characters can be entered.

Example

Request example

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

Response 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. </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. }
Thank you! We've received your feedback.