You need to enable JavaScript to run this app.
文档中心
负载均衡

负载均衡

复制全文
下载 pdf
监听器
DescribeListenerHealth - 查询指定监听器关联后端服务器的健康检查信息
复制全文
下载 pdf
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。​
  • 多个监听器ID之间使用&分隔。​
​
OnlyUnHealthy boolean 可选 示例值:true​
是否仅返回健康检查状态“异常”的后端服务器信息。取值如下:​
  • false​
  • 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​
后端服务器的类型。​
  • ecs:云服务器。​
  • eni:网卡。​
​
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​
后端服务器的状态。​
  • Up:正常。​
  • Down:异常。​
​
​
Status string 示例值:Active​
监听器状态。​
  • Active:正常。​
  • Error:存在异常。​
  • NoTarget:无目标。​
  • Disabled:未开启。​
​
TotalBackendServerCount integer 示例值:50​
监听器下后端服务器总数。​
​
UnHealthyCount integer 示例值:3​
健康检查状态为 异常 的后端服务器总数。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeListenerHealth&Version=2020-04-01&ListenerIds.1=lsn-123***765&OnlyUnHealthy=true HTTP/1.1​
Host: alb.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/alb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2021122917************14702044B16",​
"Action": "DescribeListenerHealth",​
"Version": "2020-04-01",​
"Service": "alb",​
"Region": "cn-beijing"​
},​
"Result": {​
"RequestId": "20210816110638****2514606306AF947C",​
"Listeners": [​
{​
"ListenerId": "lsn-123****7654",​
"TotalCount": 1,​
"UnHealthyCount": 1,​
"Status": "Error",​
"Results": [​
{​
"ServerId": "rs-3ciw6son****46c6rrtl3tpi3",​
"InstanceId": "i-3tli51pv****j0wuvaeh",​
"ServerGroupId": "rsp-2fe5fl3****405oxruwbagicr",​
"Type": "ecs",​
"Ip": "172.16.1.242",​
"Port": 1,​
"RuleNumber": 1,​
"Status": "Down"​
}​
]​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
Invalid%s.Malformed​
MismatchThe specified %s is malformed.​
指定的 %s 参数格式不合法。​
400​
MissingParameter​
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, '%s'.​
该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如: %s。​
400​
InvalidParameter​
Data unmarshal failed.​
请求解析失败。​
400​
LimitExceed.Listener​
You've reached the limit on the number of listeners that you can operate at a time.​
已达到单次可操作的监听器的数量上限。​
404​
InvalidListener.NotFound​
The specified Listener does not exist.​
指定的监听器不存在。​
500​
InternalError​
An internal error has occurred.​
发生内部错误。请稍后重试或联系工程师进一步咨询。​
​
​
最近更新时间:2026.02.27 11:57:36
这个页面对您有帮助吗?
有用
有用
无用
无用