创建UDP监听。

说明 新建的监听的状态为stopped。创建完成后,需调用 StartLoadBalancerListener接口启动监听进行流量转发。

调试

点击这里在OpenAPI Explorer中可视化调试,并自动生成SDK调用示例。

请求参数

名称 类型 是否必须 描述
Action String 要执行的操作。取值:

CreateLoadBalancerUDPListener

RegionId String 负载均衡实例的地域。

您可以通过调用 DescribeRegions接口获取地域ID。

LoadBalancerId String 负载均衡实例ID。
ListenerPort Integer 负载均衡实例前端使用的端口,取值:

1-65535

BackendServerPort Integer 负载均衡实例后端使用的端口。取值:

1-65535

说明 如果不使用服务器组(不指定 VServerGroupId参数),则该参数必选。
VServerGroupId String 服务器组ID。
MasterSlaveServerGroupId String 主备服务器组ID。
说明 VServerGroupIdMasterSlaveServerGroupId参数不能同时指定。
Bandwidth Integer 监听的带宽峰值,取值:
  • -1:不限制带宽峰值。
  • [1-5000]:监听的带宽峰值,所有监听的带宽峰值之和不能超过实例的带宽峰值。
Description String

设置监听的描述信息。

Scheduler String 调度算法。取值:
  • wrr(默认值):权重值越高的后端服务器,被轮询到的次数(概率)也越高。
  • wlc:除了根据每台后端服务器设定的权重值来进行轮询,同时还考虑后端服务器的实际负载(即连接数)。当权重值相同时,当前连接数越小的后端服务器被轮询到的次数(概率)也越高。
  • rr:按照访问顺序依次将外部请求依序分发到后端服务器。
  • sch:基于源IP地址的一致性hash,相同的源地址会调度到相同的后端服务器。
  • tch:基于四元组的一致性hash(源IP+目的IP+源端口+目的端口),相同的流会调度到相同的后端服务器。
  • qch:基于QUIC Connection ID一致性hash,相同的QUIC Connection ID会调度到相同的后端服务器。
说明 仅有性能保障型实例支持 schtchqch一致性hash算法。
AclStatus String 是否开启访问控制功能。

取值:on | off(默认值)

AclType String

访问控制类型:

  • white: 仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求,白名单适用于应用只允许特定IP访问的场景。

    设置白名单存在一定业务风险。一旦设置白名单,就只有白名单中的IP可以访问负载均衡监听。如果开启了白名单访问,但访问策略组中没有添加任何IP,则负载均衡监听会转发全部请求。

  • black: 来自所选访问控制策略组中设置的IP地址或地址段的所有请求都不会转发,黑名单适用于应用只限制某些特定IP访问的场景。

    如果开启了黑名单访问,但访问策略组中没有添加任何IP,则负载均衡监听会转发全部请求。

AclStatus参数的值为on时,该参数必选。

AclId String 监听绑定的访问策略组ID。

AclStatus参数的值为on时,该参数必选。

HealthyThreshold Integer 健康检查连续成功多少次后,将后端服务器的健康检查状态由fail判定为success。

取值:2-10

UnhealthyThreshold Integer 健康检查连续失败多少次后,将后端服务器的健康检查状态由success判定为fail。

取值:2-10

HealthCheckConnectTimeout Integer 接收来自运行状况检查的响应需要等待的时间。如果后端ECS在指定的时间内没有正确响应,则判定为健康检查失败。

取值:1-300(秒)

说明 如果 HealthCheckConnectTimeout的值小于 HealthCheckInterval的值,则 HealthCheckConnectTimeout无效,超时时间为 HealthCheckInterval的值。
HealthCheckInterval Integer 健康检查的时间间隔。

取值:1-50(秒)

HealthCheckReq String UDP监听健康检查的请求串,只允许包含字母、数字字符,最大长度限制为500字符。
HealthCheckExp String UDP监听健康检查的响应串,只允许包含字母、数字字符,最大长度限制为500字符。

返回参数

名称 类型 说明
RequestId String 请求ID。

示例

请求示例

https://slb.aliyuncs.com/?Action=CreateLoadBalancerUDPListener
&LoadBalancerId=lb-t4nj5vuz8ish9emfk1f20
&ListenerPort=443
&BackendServerPort=443
&Bandwidth=-1
&VServerGroupId=rsp-cige6j5e7p
&公共请求参数
返回示例
  • XML格式

    <?xml version="1.0" encoding="UTF-8"?>
    <CreateLoadBalancerUDPListenerResponse>
    	<RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    </CreateLoadBalancerUDPListenerResponse>
  • JSON格式

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