查询监听器列表

最近更新时间:2026-07-07 10:57:56

我的收藏

1. 接口描述

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

查询监听器列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeListeners。
Version String 公共参数,本接口取值:2025-10-30。
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerId String 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
示例值:alb-f8q2xk9m
Filters.N Array of Filter 过滤条件列表,最大支持20个。支持以下几个字段
- Protocol: 协议类型
- Tags: 标签
ListenerIds.N Array of String 监听器 ID 列表,ID 格式为 lst- 后接 8 位字母数字。
示例值:["lst-d9p3k7wa"]
MaxResults Integer 本次读取的最大数据记录数量。
取值: 1~100。
默认值: 20
示例值:20
NextToken String 下一次查询的令牌(Token)。为空时查询第一页。
示例值:2c44874464923a9f

3. 输出参数

参数名称 类型 描述
Listeners Array of ListenerOutput 监听器信息。
LoadBalancerId String 负载均衡实例 ID,格式为 alb- 后接 8 位字母数字。
示例值:alb-f8q2xk9m
MaxResults Integer 本次读取的最大数据记录数量。
示例值:20
NextToken String 下一次查询的令牌。
示例值:2c44874464923a9f
TotalCount Integer 总条目数。
示例值:200
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询监听器列表

输入示例

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

{
    "LoadBalancerId": "alb-f8q2xk9m",
    "MaxResults": 10
}

输出示例

{
    "Response": {
        "LoadBalancerId": "alb-f8q2xk9m",
        "Listeners": [
            {
                "ListenerId": "lst-d9p3k7wa",
                "ListenerName": "443",
                "ListenerProtocol": "HTTPS",
                "ListenerPort": 80,
                "ListenerStatus": "Active",
                "GzipEnabled": false,
                "Http2Enable": false,
                "CaEnable": false,
                "RequestTimeout": 60,
                "IdleTimeout": 15,
                "TlsSecurityPolicyId": "tls-t2ckydug",
                "XForwardedForConfig": {
                    "XForwardedForMode": "append",
                    "XForwardedForProtoEnabled": false,
                    "XForwardedForPortEnabled": false,
                    "XForwardedForHostEnabled": false,
                    "XForwardedForClientSrcPortEnabled": false,
                    "XTencentClientSDNEnabled": false,
                    "XTencentClientIDNEnabled": false,
                    "XTencentClientSerialEnabled": false,
                    "XTencentClientVerifyEnabled": false
                },
                "Tags": []
            }
        ],
        "TotalCount": 1,
        "MaxResults": 1,
        "NextToken": "",
        "RequestId": "1d92eab2-8e5b-4c29-b1b8-4454479c7196"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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