- 文档首页
负载均衡
API 参考
监听器
DescribeListenerHealth - 查询指定监听器关联后端服务器的健康检查信息
监听器
DescribeListenerHealth - 查询指定监听器关联后端服务器的健康检查信息
DescribeListenerHealth - 查询指定监听器关联后端服务器的健康检查信息
调用 DescribeListenerHealth 接口,查询指定监听器关联后端服务器的健康检查信息。
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
请求参数
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。 Action string 必选 示例值:DescribeListenerHealth
要执行的操作,取值:DescribeListenerHealth。
Version string 必选 示例值:2020-04-01
API的版本,取值:2020-04-01。
ListenerIds.N string[] 必选 示例值:ListenerIds.1=lsn-abc*****&ListenerIds.2=lsn-def*******
监听器的ID。
- 参数- N:表示监听器的序号,取值范围为1 ~ 10。
OnlyUnHealthy boolean 可选 示例值:true
是否仅返回健康检查状态“异常”的后端服务器信息。取值如下:
ProjectName string 可选 示例值:default
监听器所属项目名称。
返回参数
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。 RequestId string 示例值:20210816110638****2514606306AF947C
请求 ID。
TotalCount integer 示例值:26
本次查询的监听器总数。
Listeners object[] 示例值:-
监听器的列表。
ListenerId string 示例值:lsn-12344***765
监听器 ID 。
Results object[] 示例值:-
异常服务器的详情。
ServerId string 示例值:rs-123****654
后端服务器 ID。
InstanceId string 示例值:i-123****765
云服务器实例或者网卡的 ID。
Type string 示例值:esc
后端服务器的类型。
Ip string 示例值:192.168.0.1
后端服务器的 IP 地址。
Port integer 示例值:443
后端服务器的端口号。
RuleNumber integer 示例值:12
后端服务器关联的转发规则数。
ServerGroupId string 示例值:rsp-123****765
后端服务器所属服务器组 ID 。
ServerGroupName string 示例值:服务器组1
后端服务器所属服务器组的名称。
Status string 示例值:Down
后端服务器的状态。
Status string 示例值:Active
监听器状态。
TotalBackendServerCount integer 示例值:50
监听器下后端服务器总数。
UnHealthyCount integer 示例值:3
健康检查状态为 异常 的后端服务器总数。
请求示例
返回示例
错误码
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
最近更新时间:2026.02.27 11:57:36