调用SetLoadBalancerUDPListenerAttribute修改UDP协议监听的配置。

说明
  • API调用频率:100次/秒。
  • 单用户调用频率:10次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SetLoadBalancerUDPListenerAttribute

系统规定参数。取值:SetLoadBalancerUDPListenerAttribute

LoadBalancerId String lb-5pzipr2fszqtl2xf64uy5****

负载均衡实例的ID。

ListenerPort Integer 80

负载均衡实例前端使用的端口。取值:1~65535

Description String example

设置监听的描述信息。长度限制为1~80个字符。

说明 不能以http://https://开头。
Scheduler String wrr

调度算法。取值:

  • wrr:权重值越高的后端服务器,被轮询到的次数(概率)也越高。
  • wlc:除了根据每台后端服务器设定的权重值来进行轮询,同时还考虑后端服务器的实际负载(即连接数)。当权重值相同时,当前连接数越小的后端服务器被轮询到的次数(概率)也越高。
  • rr:按照访问顺序依次将外部请求依序分发到后端服务器。
  • sch:基于源IP地址的一致性Hash,相同的源地址会调度到相同的后端服务器。
  • qch:基于QUIC Connection ID一致性Hash,相同的QUIC Connection ID会调度到相同的后端服务器。
  • iqch:针对iQUIC CID的特定三个字节进行一致Hash,第2~第4三个字节相同的会调度到相同的后端服务器。
HealthyThreshold Integer 4

健康检查连续成功多少次后,将后端服务器的健康检查状态由fail(后台服务器不可达)判定为success(后台服务器可达)。取值:2~10

UnhealthyThreshold Integer 4

健康检查连续失败多少次后,将后端服务器的健康检查状态由success(后台服务器可达)判定为fail(后台服务器不可达)。取值:2~10

HealthCheckConnectTimeout Integer 100

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

  • 默认值:5秒。
  • 取值:1~300
  • 单位:秒。
说明 如果HealthCheckConnectTimeout的值小于HealthCheckInterval的值,则HealthCheckConnectTimeout无效,超时时间为HealthCheckInterval的值。
HealthCheckInterval Integer 5

健康检查的时间间隔。取值:1~50,单位:秒。

HealthCheckConnectPort Integer 8080

健康检查使用的端口,取值:1~65535。不设置此参数时,表示使用后端服务端口(BackendServerPort)。

HealthCheckReq String hello

UDP监听健康检查的请求串,只允许包含字母、数字,最大长度限制为64个字符。

HealthCheckExp String ok

UDP监听健康检查的响应串,只允许包含字母、数字,最大长度限制为64个字符。

EipTransmit String on

是否开启EIP透传,取值:

  • on:开启。
  • off(默认值):关闭。

返回数据

名称 类型 示例值 描述
RequestId String 06F00FBB-3D9E-4CCE-9D43-1A6946A75456

请求ID。

示例

请求示例

https://ens.aliyuncs.com/?Action=SetLoadBalancerUDPListenerAttribute
&LoadBalancerId=lb-5pzipr2fszqtl2xf64uy5****
&ListenerPort=80
&Description=example
&Scheduler=wrr
&HealthyThreshold=4
&UnhealthyThreshold=4
&HealthCheckConnectTimeout=100
&HealthCheckInterval=5
&HealthCheckConnectPort=8080
&HealthCheckReq=hello
&HealthCheckExp=ok
&EipTransmit=on
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SetLoadBalancerUDPListenerAttributeResponse>
    <RequestId>06F00FBB-3D9E-4CCE-9D43-1A6946A75456</RequestId>
</SetLoadBalancerUDPListenerAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "06F00FBB-3D9E-4CCE-9D43-1A6946A75456"
}

错误码

HttpCode 错误码 错误信息 描述
400 Invalid%s The specified parameter %s is invalid. 参数不正确
400 Missing%s You must specify the parameter %s. 参数为必填
400 IncorrectInstanceStatus The current status of the resource does not support this operation. 当前操作不被支持,磁盘正在重置中。
400 NoPermission Permission denied. 没有足够的权限,请联系云账号管理员授予您相应权限。

访问错误中心查看更多错误码。