应用型负载均衡查询监听器详细信息

1. 接口描述

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

查询单个监听器详情

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeListenerDetail。
Version	是	String	公共参数，本接口取值：2025-10-30。
Region	是	String	公共参数，详见产品支持的地域列表。
ListenerId	是	String	监听器 ID，格式为 lst- 后接 8 位字母数字。示例值：lst-d9p3k7wa
LoadBalancerId	是	String	负载均衡实例 ID，格式为 alb- 后接 8 位字母数字。示例值：alb-f8q2xk9m

3. 输出参数

参数名称	类型	描述
CaCertificateIds	Array of String	监听器绑定的CA证书ID列表。示例值：["Fm8Wp7x8"]
CaEnabled	Boolean	是否开启双向认证。示例值：false
CertificateIds	Array of String	服务器证书 ID 列表。示例值：["Fm8Wp7x8"]
CreateTime	Timestamp ISO8601	监听器实例的创建时间。格式：ISO 8601（例如 2025-01-01T08:30:00+08:00）示例值：2025-01-01T08:30:00+08:00
DefaultActions	Array of DefaultAction	规则动作列表。
GzipEnabled	Boolean	是否启用 Gzip 压缩。示例值：false
Http2Enabled	Boolean	是否开启HTTP/2特性。示例值：true
IdleTimeout	Integer	指定连接空闲超时时间。单位：秒。示例值：15
ListenerId	String	监听器 ID，格式为 lst- 后接 8 位字母数字。示例值：lst-d9p3k7wa
ListenerName	String	自定义监听名称。示例值：http_listener
ListenerPort	Integer	负载均衡实例前端使用的端口。示例值：80
ListenerProtocol	String	监听协议。示例值：HTTP
ListenerStatus	String	监听器状态。取值:= - Active: 运行中。 - Provisioning：创建中。 - Configuring：变配中。 - ProvisionFailed：创建失败示例值：Active
LoadBalancerId	String	负载均衡实例 ID，格式为 alb- 后接 8 位字母数字。示例值：alb-f8q2xk9m
ModifyTime	Timestamp ISO8601	监听器实例的最后变更时间。格式：ISO 8601（例如 2025-01-01T08:30:00+08:00）示例值：2025-01-01T08:30:00+08:00
RequestTimeout	Integer	请求超时时间。单位：秒。示例值：60
SecurityPolicyId	String	安全策略 ID，格式为 tls- 后接 8 位字母数字。示例值：tls-t2ckydug
Tags	Array of TagInfo	标签。
XForwardedForConfig	XForwardedForConfig	XForwardedFor配置。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询监听器详情

输入示例

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

{
    "LoadBalancerId": "alb-f8q2xk9m",
    "ListenerId": "lst-d9p3k7wa"
}

输出示例

{
    "Response": {
        "LoadBalancerId": "alb-f8q2xk9m",
        "ListenerId": "lst-d9p3k7wa",
        "ListenerName": "443",
        "ListenerPort": 80,
        "ListenerProtocol": "HTTPS",
        "ListenerStatus": "Active",
        "CertificateIds": [
            "Fm8Wp7x8"
        ],
        "CaCertificateIds": [],
        "GzipEnabled": false,
        "CaEnabled": false,
        "Http2Enabled": false,
        "SecurityPolicyId": "tls-t2ckydug",
        "IdleTimeout": 15,
        "RequestTimeout": 60,
        "XForwardedForConfig": {
            "XForwardedForMode": "append",
            "XForwardedForProtoEnabled": false,
            "XForwardedForPortEnabled": false,
            "XForwardedForHostEnabled": false,
            "XForwardedForClientSrcPortEnabled": false,
            "XTencentClientSDNEnabled": false,
            "XTencentClientIDNEnabled": false,
            "XTencentClientSerialEnabled": false,
            "XTencentClientVerifyEnabled": false
        },
        "DefaultActions": [
            {
                "Type": "TargetGroup",
                "TargetGroupConfig": {
                    "TargetGroups": [
                        {
                            "TargetGroupId": "lbtg-0zrnc9qa",
                            "Weight": 10
                        }
                    ]
                }
            }
        ],
        "Tags": [],
        "RequestId": "cb7e17c7-9e71-42d2-9fa6-ed98bef10c93"
    }
}

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. 错误码

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

查询监听器详细信息

本页目录：