调用DescribeLoadBalancerUDPListenerAttribute查询UDP监听的配置。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String 否 cn-hangzhou

负载均衡实例的地域ID。
Action String 是 DescribeLoadBalancerUDPListenerAttribute

系统规定参数。取值：DescribeLoadBalancerUDPListenerAttribute。

LoadBalancerId String 是 lb-bp1rtfnodmywb43e*****

传统型负载均衡实例ID。
ListenerPort Integer 是 80

传统型负载均衡实例前端使用的端口。

取值：1~65535。

返回数据

名称 类型 示例值 描述
VServerGroupId String rsp-cige6j****

绑定的虚拟服务器组ID。
Status String stopped

当前监听的状态。取值：

  • running：监听正常运行。
  • stopped：监听停止运行。
AclType String white

访问控制类型：

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

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

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

    如果开启了黑名单访问，但访问策略组中没有添加任何IP，则负载均衡监听会转发全部请求。
RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

请求ID。
HealthCheckConnectPort Integer 8080

健康检查的端口。取值：1~65535。不设置此参数时，表示使用后端服务端口（BackendServerPort）。

说明 在HealthCheck值为on时才会有效。
Description String test

监听的描述信息。
Bandwidth Integer -1

监听的带宽峰值，单位Mbps。取值：

  • -1：对于按流量计费的公网负载均衡实例，可以将带宽峰值设置为-1，即不限制带宽峰值。
  • 1~5120：对于按带宽计费的公网负载均衡实例，可以设置每个监听的带宽峰值，但所有监听的带宽峰值之和不能超过实例的带宽峰值。
MasterSlaveServerGroupId String rsp-0bfucw****

绑定的主备服务器组ID。
BackendServerPort Integer 90

传统型负载均衡实例后端使用的端口。

说明 如果后端服务器组为虚拟服务器组，则不返回该参数。
AclStatus String off

是否开启访问控制功能。取值：on或off（默认值）。

UnhealthyThreshold Integer 4

不健康检查阈值。健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。取值：2~10。

ProxyProtocolV2Enabled Boolean false

是否支持通过Proxy Protocol协议携带客户端源地址到后端服务器。取值：

  • true：是。
  • false：否。
ListenerPort Integer 53

传统型负载均衡实例前端使用的端口。
HealthCheckInterval Integer 5

健康检查的时间间隔，取值：1~50秒。

HealthCheckExp String ok

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

访问控制策略组ID。
Scheduler String wrr

调度算法，取值：

  • wrr（默认值）：权重值越高的后端服务器，被轮询到的次数（概率）也越高。
  • rr：按照访问顺序依次将外部请求依序分发到后端服务器。
HealthCheckConnectTimeout Integer 100

接收来自运行状况检查的响应需要等待的时间。如果后端ECS在指定的时间内没有正确响应，则判定为健康检查失败。取值：1~300秒。

HealthyThreshold Integer 4

健康检查阈值。健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。取值：2~10。

HealthCheckReq String hello

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

是否开启健康检查。取值：

  • on：开启。
  • off：关闭。
LoadBalancerId String lb-bp1rtfnodmywb43e*****

传统型负载均衡实例ID。

示例

请求示例

http(s)://[Endpoint]/?RegionId=cn-hangzhou
&Action=DescribeLoadBalancerUDPListenerAttribute
&LoadBalancerId=lb-bp1rtfnodmywb43e*****
&ListenerPort=80
&公共请求参数

正常返回示例

XML格式 

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

<DescribeLoadBalancerUDPListenerAttributeResponse>
    <VServerGroupId>rsp-cige6j****</VServerGroupId>
    <Status>stopped</Status>
    <AclType>white</AclType>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    <HealthCheckConnectPort>8080</HealthCheckConnectPort>
    <Description>test</Description>
    <Bandwidth>-1</Bandwidth>
    <MasterSlaveServerGroupId>rsp-0bfucw****</MasterSlaveServerGroupId>
    <BackendServerPort>90</BackendServerPort>
    <AclStatus>off</AclStatus>
    <UnhealthyThreshold>4</UnhealthyThreshold>
    <ProxyProtocolV2Enabled>false</ProxyProtocolV2Enabled>
    <ListenerPort>53</ListenerPort>
    <HealthCheckInterval>5</HealthCheckInterval>
    <HealthCheckExp>ok</HealthCheckExp>
    <AclId>123943****</AclId>
    <Scheduler>wrr</Scheduler>
    <HealthCheckConnectTimeout>100</HealthCheckConnectTimeout>
    <HealthyThreshold>4</HealthyThreshold>
    <HealthCheckReq>hello</HealthCheckReq>
    <HealthCheck>on</HealthCheck>
    <PortRanges/>
    <LoadBalancerId>lb-bp1rtfnodmywb43e*****</LoadBalancerId>
</DescribeLoadBalancerUDPListenerAttributeResponse>

JSON格式 

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

{
  "VServerGroupId" : "rsp-cige6j****",
  "Status" : "stopped",
  "AclType" : "white",
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "HealthCheckConnectPort" : 8080,
  "Description" : "test",
  "Bandwidth" : -1,
  "MasterSlaveServerGroupId" : "rsp-0bfucw****",
  "BackendServerPort" : 90,
  "AclStatus" : "off",
  "UnhealthyThreshold" : 4,
  "ProxyProtocolV2Enabled" : false,
  "ListenerPort" : 53,
  "HealthCheckInterval" : 5,
  "HealthCheckExp" : "ok",
  "AclId" : "123943****",
  "Scheduler" : "wrr",
  "HealthCheckConnectTimeout" : 100,
  "HealthyThreshold" : 4,
  "HealthCheckReq" : "hello",
  "HealthCheck" : "on",
  "AclIds" : [ ],
  "PortRanges" : [ { } ],
  "LoadBalancerId" : "lb-bp1rtfnodmywb43e*****"
}

错误码

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