查询负载均衡的监听器列表

最近更新时间:2024-03-12 01:29:07

我的收藏

1. 接口描述

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

查询负载均衡的监听器列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeListeners。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,本接口不需要传递此参数。
LoadBalancerId String 负载均衡实例 ID
ListenerIds.N Array of String 要查询的负载均衡监听器 ID数组
Protocol String 要查询的监听器协议类型,取值 TCP | UDP
Port Integer 要查询的监听器的端口

3. 输出参数

参数名称 类型 描述
Listeners Array of Listener 监听器列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 总的监听器个数
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询负载均衡的监听器列表

输入示例

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

输出示例

{
    "Response": {
        "RequestId": "dcb32a03-de71-437a-9f92-a703e6d82927",
        "TotalCount": 2,
        "Listeners": [
            {
                "HealthCheck": {
                    "HealthNum": 3,
                    "IntervalTime": 5,
                    "UnHealthyNum": 3,
                    "TimeOut": 2,
                    "CheckType": "TCP",
                    "HealthSwitch": 1
                },
                "CreateTime": "2020-07-21 20:15:54",
                "ListenerId": "lbl-knd4jr8m",
                "Port": 13001,
                "Scheduler": "WRR",
                "Protocol": "TCP",
                "SessionExpireTime": 0,
                "ListenerName": ""
            },
            {
                "HealthCheck": {
                    "HealthNum": 3,
                    "IntervalTime": 5,
                    "UnHealthyNum": 3,
                    "TimeOut": 2,
                    "CheckType": "TCP",
                    "HealthSwitch": 1
                },
                "CreateTime": "2020-07-21 20:15:54",
                "ListenerId": "lbl-2fcyclbg",
                "Port": 13002,
                "Scheduler": "WRR",
                "Protocol": "TCP",
                "SessionExpireTime": 0,
                "ListenerName": ""
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InternalOperationFailure 内部操作错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameter.InvalidDataFormat 数据格式不正确。
InvalidParameter.LBIdNotFound 负载均衡实例ID错误。
InvalidParameterValue.InvalidPublicParam 公共参数不合法。
InvalidParameterValue.Length 参数长度错误。
UnauthorizedOperation.ForbiddenOperation 没有权限进行该操作。