查询监听及其转发规则的健康检查状态。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| alb:GetListenerHealthStatus | get | *LoadBalancer acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ListenerId | string | 是 | 实例的监听 ID。 | lsn-o4u54y73wq7b****** |
| IncludeRule | boolean | 否 | 是否包含转发规则的检查结果。取值：
| true |
| NextToken | string | 否 | 是否拥有下一次查询的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults | long | 否 | 分批次查询时每次显示的最大条目数。取值范围：1~30，默认值为 20。 | 20 |
返回参数
示例
正常返回示例
JSON格式
{
"ListenerHealthStatus": [
{
"ListenerId": "lsn-o4u54y73wq7b******",
"ListenerPort": 80,
"ListenerProtocol": "http",
"ServerGroupInfos": [
{
"HealthCheckEnabled": "on",
"NonNormalServers": [
{
"Port": 90,
"Reason": {
"ActualResponse": "302",
"ExpectedResponse": "HTTP_2xx",
"ReasonCode": "RESPONSE_MISMATCH"
},
"ServerId": "i-uf62h8v******",
"ServerIp": "192.168.8.10",
"Status": "Initial"
}
],
"ServerGroupId": "sgp-8ilqs4axp6******",
"ActionType": "TrafficMirror"
}
]
}
],
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876F******",
"RuleHealthStatus": [
{
"RuleId": "rule-hp34s2h0xx1ht4nwo****",
"ServerGroupInfos": [
{
"HealthCheckEnabled": "on",
"NonNormalServers": [
{
"Port": 90,
"Reason": {
"ActualResponse": "302",
"ExpectedResponse": "HTTP_2xx",
"ReasonCode": "RESPONSE_MISMATCH"
},
"ServerId": "i-uf62h8v******",
"ServerIp": "192.168.2.11",
"Status": "Initial"
}
],
"ServerGroupId": "sgp-8ilqs4axp6******",
"ActionType": "TrafficMirror"
}
]
}
],
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | Forbidden.LoadBalancer | Authentication is failed for %s. | 负载均衡操作鉴权失败。 |
| 404 | ResourceNotFound.LoadBalancer | The specified resource %s is not found. | 资源%s不存在。 |
| 404 | ResourceNotFound.Listener | The specified resource %s is not found. | 监听不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-01-29 | OpenAPI 错误码发生变更 | 查看变更详情 |