文档中心 API 中心 负载均衡 传统型负载均衡相关接口 获取传统型负载均衡监听器列表

获取传统型负载均衡监听器列表

最近更新时间:2019-07-24 15:14:58

1. 接口描述

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

DescribeClassicalLBListeners 接口用于获取传统型负载均衡的监听器信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClassicalLBListeners
Version String 公共参数,本接口取值:2018-03-17
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerId String 负载均衡实例 ID
ListenerIds.N Array of String 负载均衡监听器ID列表
Protocol String 负载均衡监听的协议, 'TCP', 'UDP', 'HTTP', 'HTTPS'
ListenerPort Integer 负载均衡监听端口, 范围[1-65535]
Status Integer 监听器的状态,0 表示创建中,1 表示运行中

3. 输出参数

参数名称 类型 描述
Listeners Array of ClassicalListener 监听器列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取一个传统型负载均衡的监听器信息

输入示例

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

输出示例

{
  "Response": {
    "Listeners": [
      {
        "ListenerId": "lbl-3jur3gei",
        "ListenerPort": 111,
        "InstancePort": 1111,
        "ListenerName": "test",
        "Protocol": "tcp",
        "SessionExpire": 0,
        "HealthSwitch": 1,
        "TimeOut": 2,
        "IntervalTime": 5,
        "HealthNum": 3,
        "UnhealthNum": 3,
        "HttpHash": "",
        "HttpCode": 31,
        "HttpCheckPath": "",
        "SSLMode": "",
        "CertId": "",
        "CertCaId": "",
        "Status": 1
      }
    ],
    "RequestId": "5da375f4-214d-42bb-8d50-e74bf556b38f"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter 参数错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue 参数取值错误
InvalidParameterValue.Length 参数长度错误。
LimitExceeded 超过配额限制
ResourceInsufficient 资源不足
UnauthorizedOperation 未授权操作