应用型负载均衡查询监听器健康状态

1. 接口描述

接口请求域名： alb.tencentcloudapi.com 。

查询监听器健康状态。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeListenerHealthStatus。
Version	是	String	公共参数，本接口取值：2025-10-30。
Region	是	String	公共参数，详见产品支持的地域列表。
ListenerId	是	String	监听器 ID，格式为 lst- 后接 8 位字母数字。示例值：lst-d9p3k7wa
LoadBalancerId	是	String	负载均衡实例 ID，格式为 alb- 后接 8 位字母数字。示例值：alb-f8q2xk9m
IncludeRule	否	Boolean	是否包含转发规则的健康检查结果。为false时只返回默认转发规则的健康状态，为true时返回全部规则的健康状态(包含默认规则)。取值： true：是。 false（默认值）：否。示例值：false
MaxResults	否	Integer	本次读取的最大数据记录数量。取值: 1~100。默认值: 20 示例值：20
NextToken	否	String	下一页查询的Token值。第一次查询时，无需填写。示例值：2c44874464923a9f

3. 输出参数

参数名称	类型	描述
ListenerId	String	监听器 ID，格式为 lst- 后接 8 位字母数字。示例值：lst-d9p3k7wa
ListenerPort	String	监听器端口。示例值：80
ListenerProtocol	String	监听器协议。示例值：HTTP
NextToken	String	下一次查询的令牌（Token）。为空时表示这是最后一页。示例值：2c44874464923a9f
RuleHealthStatusInfos	Array of RuleHealthStatusInfo	转发规则健康状态。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询监听器健康状态

输入示例

POST / HTTP/1.1
Host: alb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeListenerHealthStatus
<公共请求参数>

{
    "IncludeRule": false,
    "ListenerId": "lst-d9p3k7wa",
    "LoadBalancerId": "alb-f8q2xk9m",
    "MaxResults": 20
}

输出示例

{
    "Response": {
        "ListenerId": "lst-d9p3k7wa",
        "ListenerPort": "80",
        "ListenerProtocol": "HTTP",
        "NextToken": "2c44874464923a9f",
        "RuleHealthStatusInfos": [
            {
                "IsDefaultRule": "false",
                "RuleId": "rule-h8cy5gwl",
                "TargetGroupHealthInfos": [
                    {
                        "HealthCheckEnabled": true,
                        "TargetGroupId": "lbtg-0zrnc9qa",
                        "TargetHealthStatusInfos": [
                            {
                                "Status": "Healthy",
                                "TargetId": "ins-x8q2m4pa",
                                "TargetIp": "10.0.0.1",
                                "TargetPort": 80
                            }
                        ],
                        "Type": "TargetGroup"
                    }
                ]
            }
        ],
        "RequestId": "3b848733-70e5-4558-ae39-4b9938eb7609"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询监听器健康状态

本页目录：