CreateLoadBalancerUDPListener

Last Updated: Jul 03, 2017

Description

  • Creates a UDP Listener. This creates a listener based on UDP protocol for an Server Load Balancer instance, including UDP-based policies and health check configurations.

  • New listeners are in the Stopped status. The user must call StartLoadBalancerListener to activate them.

  • Health checks for UDP Listeners are permanently enabled. Users can configure various parameters for health checks, bust cannot disable them.

  • Note: Currently, UDP protocol for classic Server Load Balancer instances does not allow users to view source addresses.

Request Parameters

Name Type Required? Description
Action String Yes Operator interface name, required parameter.
Value:CreateLoadBalancerUDPListener
LoadBalancerId String Yes Unique ID of an Server Load Balancer instance.
ListenerPort Integer Yes Server Load Balancer instance’s frontend port.
Value:1-65535
BackendServerPort Integer Yes Server Load Balancer instance’s backend port.
Value:1-65535
Bandwidth Integer No Listener’s upper limit bandwidth.
Value: -1 | 1-1000Mbps;
For public instances using the PayByTraffic billing method, users can set the listener bandwidth to -1. This indicates the peak bandwidth is not restricted.
Scheduler String No Scheduling algorithm.
Value:wrr | wlc
Default value:wrr
PersistenceTimeout Integer No Connection persistence timeout time.
Value: 0-3600 (unit: seconds)
Default value: 0
0 indicates disabled.
HealthCheckConnectPort Integer No Port used for health checks.
Value: 1-65535
Default value: None
When users do not set this parameter, this indicates BackendServerPort is used.
HealthyThreshold Integer No Threshold value for determining health check results as Success. That is, after this number of successful health checks, the backend server’s health check results will change from Fail to Success.
Value: 1-10
Default value:3
UnhealthyThreshold Integer No Threshold value for determining health check results as Fail. That is, after this number of failed health checks, the backend server’s health check results will change from Success to Fail.
Value:1-10
Default value:3
HealthCheckConnectTimeout Integer No Health check connection timeout time.
Value: 1-50 (unit: seconds)
Default value:5
HealthCheckInterval Integer No Interval between health checks.
Value: 1-5 (unit: seconds)
Default value:2
VServerGroupId String No Virtual server group ID. Virtual server group ID and master-slave server group ID cannot be both used at the same time.
MasterSlaveServerGroupId String No Master-slave server group. Virtual server group ID and master-slave server group ID cannot be both used at the same time.

Return Parameters

All are public return parameters. See Public Parameters.

Example

Request Example

  1. https://slb.aliyuncs.com/
  2. &Action=CreateLoadBalancerUDPListener
  3. &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
  4. &ListenerPort=53
  5. &BackendServerPort=53
  6. &Bandwidth=-1
  7. &VServerGroupId=rsp-cige6j5e7p
  8. &<public request parameters>

Return Example

  • XML format
    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <CreateLoadBalancerUDPListenerResponse>
    3. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    4. </CreateLoadBalancerUDPListenerResponse>
  • JSON format
    1. {"RequestId":" CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
    2. }
Thank you! We've received your feedback.