调用DescribeLoadBalancerUDPListenerAttribute查询UDP监听的配置

查询UDP监听的配置。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
slb:DescribeLoadBalancerUDPListenerAttribute	get	loadbalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}	slb:tag	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	负载均衡实例的地域 ID。	cn-hangzhou
LoadBalancerId	string	是	传统型负载均衡实例 ID。	lb-bp1rtfnodmywb43e*****
ListenerPort	integer	是	传统型负载均衡实例前端使用的端口。取值：1~65535。	80

返回参数

名称	类型	描述	示例值
	object
VServerGroupId	string	绑定的虚拟服务器组 ID。	rsp-cige6j****
Status	string	当前监听的状态。取值： running：监听正常运行。 stopped：监听停止运行。	stopped
AclType	string	访问控制类型： white：仅转发来自所选访问控制策略组中设置的 IP 地址或地址段的请求，白名单适用于应用只允许特定 IP 访问的场景。设置白名单存在一定业务风险。一旦设置白名单，就只有白名单中的 IP 可以访问负载均衡监听。如果开启了白名单访问，但访问策略组中没有添加任何 IP，则负载均衡监听会转发全部请求。 black：来自所选访问控制策略组中设置的 IP 地址或地址段的所有请求都不会转发，黑名单适用于应用只限制某些特定 IP 访问的场景。如果开启了黑名单访问，但访问策略组中没有添加任何 IP，则负载均衡监听会转发全部请求。	white
RequestId	string	请求 ID。	365F4154-92F6-4AE4-92F8-7FF34B540710
HealthCheckConnectPort	integer	健康检查的端口。取值：1~65535。不设置此参数时，表示使用后端服务端口（BackendServerPort）。说明在 HealthCheck 值为 on 时才会有效。	8080
Description	string	自定义监听名称。	UDP_80
Bandwidth	integer	监听的带宽峰值，单位 Mbps。取值： -1：对于按流量计费的公网负载均衡实例，可以将带宽峰值设置为-1，即不限制带宽峰值。 1~5120：对于按带宽计费的公网负载均衡实例，可以设置每个监听的带宽峰值，但所有监听的带宽峰值之和不能超过实例的带宽峰值。	-1
MasterSlaveServerGroupId	string	绑定的主备服务器组 ID。	rsp-0bfucw****
BackendServerPort	integer	传统型负载均衡实例后端使用的端口。说明如果后端服务器组为虚拟服务器组，则不返回该参数。	90
AclStatus	string	是否开启访问控制功能。取值：on 或 off（默认值）。	off
UnhealthyThreshold	integer	不健康检查阈值。健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。取值：2~10。	4
ProxyProtocolV2Enabled	boolean	是否支持通过 Proxy Protocol 协议携带客户端源地址到后端服务器。取值： true：是。 false：否。	false
ListenerPort	integer	传统型负载均衡实例前端使用的端口。	53
HealthCheckInterval	integer	健康检查的时间间隔，取值：1~50 秒。	5
HealthCheckExp	string	UDP 监听健康检查的响应串。只允许包含字母、数字，最大长度限制为 64 个字符。	ok
AclId	string	访问控制策略组 ID。	acl-uf60jwfiv6******
Scheduler	string	调度算法，取值： wrr（默认值）：权重值越高的后端服务器，被轮询到的次数（概率）也越高。 rr：按照访问顺序依次将外部请求依序分发到后端服务器。	wrr
HealthCheckConnectTimeout	integer	接收来自运行状况检查的响应需要等待的时间。如果后端 ECS 在指定的时间内没有正确响应，则判定为健康检查失败。取值：1~300 秒。	100
HealthyThreshold	integer	健康检查阈值。健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。取值：2~10。	4
HealthCheckReq	string	UDP 监听健康检查的请求串。只允许包含字母、数字，最大长度限制为 64 个字符。	hello
HealthCheck	string	是否开启健康检查。取值： on：开启。 off：关闭。	on
AclIds	array	访问控制策略组 ID。
LoadBalancerId	string	传统型负载均衡实例 ID。	lb-bp1rtfnodmywb43e*****
Tags	array<object>	标签列表。
Tag	object	标签列表。
TagKey	string	监听的标签键。N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。	TestKey
TagValue	string	监听的标签值。N 的取值范围：1~20。一旦传入该值，可以为空字符串。最多支持 128 个字符，不能以`acs:`开头，不能包含`http://`或者`https://`。	TestValue

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-10-09	OpenAPI 返回结构发生变更	查看变更详情
2024-05-28	OpenAPI 返回结构发生变更	查看变更详情