文档平台 API 中心 负载均衡 应用型负载均衡相关接口 查询应用型负载均衡监听器列表

查询应用型负载均衡监听器列表

最近更新时间:2019-03-07 23:49:40

1. 接口描述

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

DescribeListeners 接口可根据负载均衡器 ID,监听器的协议或者端口作为过滤条件获取监听器列表。如果不指定任何过滤条件,默认返该负载均衡器下的默认数据长度(20 个)的监听器。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:clb.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeListeners
Version String 公共参数,本接口取值:2018-03-17
Region String 公共参数,详见产品支持的地域列表
LoadBalancerId String 负载均衡实例 ID
ListenerIds.N Array of String 要查询的应用型负载均衡监听器 ID数组
Protocol String 要查询的监听器协议类型,取值 TCP | UDP | HTTP | HTTPS | TCP_SSL
Port Integer 要查询的监听器的端口

3. 输出参数

参数名称 类型 描述
Listeners Array of Listener 监听器列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询负载均衡实例下的全部监听器信息

输入示例

https://clb.tencentcloudapi.com/?Action=DescribeListeners
&LoadBalancerId=lb-1wvl0ejw
&<公共请求参数>

输出示例

{
    "Response": {
        "Listeners": [
            {
                "ListenerId": "lbl-7gogrzv2",
                "Protocol": "HTTPS",
                "Port": 1111,
                "HealthCheck": null,
                "Certificate": null,
                "Scheduler": null,
                "SessionExpireTime": null,
                "SniSwitch": 1,
                "Rules": [
                    {
                        "LocationId": "loc-8s90r6oc",
                        "Domain": "clue.foo2",
                        "Url": "/aa1",
                        "SessionExpireTime": 0,
                        "HealthCheck": {
                            "HealthSwitch": 0,
                            "TimeOut": 2,
                            "IntervalTime": 5,
                            "HealthNum": 3,
                            "UnHealthNum": 3,
                            "HttpCode": 31,
                            "HttpCheckPath": "/",
                            "HttpCheckDomain": "clue.foo",
                            "HttpCheckMethod": "head"
                        },
                        "Certificate": {
                            "SSLMode": "UNIDIRECTIONAL",
                            "CertId": "McKgYApY",
                            "CertCaId": ""
                        },
                        "Scheduler": "WRR"
                    }
                ]
            }
        ],
        "RequestId": "e571614d-c674-4dd8-9f00-4ba0f322d1c1"
    }
}

示例2 按照端口、协议及监听器ID查询监听器

输入示例

https://clb.tencentcloudapi.com/?Action=DescribeListeners
&LoadBalancerId=lb-1wvl0ejw
&Protocol=TCP
&Port=2007
&ListenerIds.0=lbl-ohamxrok
&<公共请求参数>

输出示例

{
    "Response": {
        "Listeners": [
            {
                "ListenerId": "lbl-ohamxrok",
                "Protocol": "TCP",
                "Port": 2007,
                "HealthCheck": {
                    "HealthSwitch": 1,
                    "TimeOut": 2,
                    "IntervalTime": 5,
                    "HealthNum": 3,
                    "UnHealthNum": 3,
                    "HttpCode": null,
                    "HttpCheckPath": null,
                    "HttpCheckDomain": null,
                    "HttpCheckMethod": null
                },
                "Certificate": null,
                "Scheduler": "WRR",
                "SessionExpireTime": 0,
                "SniSwitch": 0,
                "Rules": null
            }
        ],
        "RequestId": "7371485a-fa7a-48c0-b733-fa8b0fdb1a72"
    }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误
UnauthorizedOperation 未授权操作