1. 接口描述

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

DescribeListeners 接口可根据负载均衡器 ID，监听器的协议或端口作为过滤条件获取监听器列表。如果不指定任何过滤条件，则返回该负载均衡实例下的所有监听器。

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

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

2. 输入参数

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

3. 输出参数

4. 示例

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

输入示例

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

输出示例

{
  "Response": {
    "Listeners": [
      {
        "ListenerId": "lbl-mdam9r0l",
        "ListenerName": "ds",
        "Protocol": "HTTPS",
        "Port": 1,
        "HealthCheck": null,
        "Certificate": {
          "SSLMode": "UNIDIRECTIONAL",
          "CertId": "V0ODELy7",
          "CertCaId": ""
        },
        "Scheduler": null,
        "SessionExpireTime": null,
        "SniSwitch": 0,
        "Rules": [
          {
            "ListenerId": "lbl-mdam9r0l",
            "LocationId": "loc-33laioar",
            "Domain": "4.com",
            "Url": "/df",
            "Certificate": null,
            "HealthCheck": {
              "HealthSwitch": 1,
              "TimeOut": 2,
              "IntervalTime": 5,
              "HealthNum": 3,
              "UnHealthNum": 3,
              "HttpCode": 15,
              "HttpCheckPath": "/",
              "HttpCheckDomain": "4.com",
              "HttpCheckMethod": "get",
              "CheckPort": null,
              "CheckType": null,
              "HttpVersion": null,
              "ContextType": null,
              "SendContext": null,
              "RecvContext": null
            },
            "RewriteTarget": {
              "TargetListenerId": null,
              "TargetLocationId": null
            },
            "SessionExpireTime": 0,
            "Scheduler": "WRR",
            "HttpGzip": true,
            "BeAutoCreated": false,
            "DefaultServer": false,
            "Http2": false,
            "ForwardType": "HTTP"
          }
        ]
      },
      {
        "ListenerId": "lbl-pt4dgkjn",
        "ListenerName": "333",
        "Protocol": "TCP",
        "Port": 333,
        "HealthCheck": {
          "HealthSwitch": 1,
          "TimeOut": 2,
          "IntervalTime": 5,
          "HealthNum": 3,
          "UnHealthNum": 3,
          "CheckPort": null,
          "CheckType": "TCP",
          "HttpCheckDomain": null,
          "HttpCheckPath": null,
          "HttpCheckMethod": null,
          "HttpVersion": null,
          "HttpCode": null,
          "ContextType": null,
          "SendContext": null,
          "RecvContext": null
        },
        "Certificate": null,
        "Scheduler": "WRR",
        "SessionExpireTime": 0,
        "SniSwitch": 0,
        "Rules": null
      }
    ],
    "RequestId": "a031471a-332d-4c45-a123-0bc6fb212780"
  }
}

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

输入示例

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

输出示例

{
  "Response": {
    "Listeners": [
      {
        "ListenerId": "lbl-pt4dgkjn",
        "ListenerName": "333",
        "Protocol": "TCP",
        "Port": 333,
        "HealthCheck": {
          "HealthSwitch": 1,
          "TimeOut": 2,
          "IntervalTime": 5,
          "HealthNum": 3,
          "UnHealthNum": 3,
          "CheckPort": null,
          "CheckType": "TCP",
          "HttpCheckDomain": null,
          "HttpCheckPath": null,
          "HttpCheckMethod": null,
          "HttpVersion": null,
          "HttpCode": null,
          "ContextType": null,
          "SendContext": null,
          "RecvContext": null
        },
        "Certificate": null,
        "Scheduler": "WRR",
        "SessionExpireTime": 0,
        "SniSwitch": 0,
        "Rules": null
      }
    ],
    "RequestId": "0dc33bce-5fe5-4ce0-9734-d8212c258d36"
  }
}

5. 开发者资源

API Explorer

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

• API 3.0 Explorer

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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