查询负载均衡的监听器列表
最近更新时间: 2024-06-18 14:31:28
1. 接口描述
接口请求域名: clb.api3.fincloud.tencent.cn。
DescribeListeners 接口可根据负载均衡器 ID,监听器的协议或端口作为过滤条件获取监听器列表。如果不指定任何过滤条件,则返回该负载均衡实例下的所有监听器。
默认接口请求频率限制:20次/秒。
接口更新时间:2021-04-27 20:10:51。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:DescribeListeners |
Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-17 |
Region | 是 | 否 | String | 公共参数,详见产品支持的地域列表(TODO) |
LoadBalancerId | 是 | 否 | String | 负载均衡实例 ID |
ListenerIds | 否 | 否 | Array of String | 要查询的负载均衡监听器 ID数组 |
Protocol | 否 | 否 | String | 要查询的监听器协议类型,取值 TCP | UDP | HTTP | HTTPS | TCP_SSL |
Port | 否 | 否 | Int64 | 要查询的监听器的端口 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Listeners | Listener | 监听器列表 |
TotalCount | Uint64 | 总的监听器个数 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | |
InvalidParameter | |
InvalidParameter.FormatError | |
InvalidParameter.LBIdNotFound | |
UnauthorizedOperation | |
InternalError | |
InvalidParameterValue | |
InvalidParameterValue.Length |