1. 接口描述
接口请求域名: clb.tencentcloudapi.com 。
DescribeClassicalLBListeners 接口用于获取传统型负载均衡的监听器信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeClassicalLBListeners。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LoadBalancerId | 是 | String | 负载均衡实例ID。 示例值:lb-a3u5**** |
ListenerIds.N | 否 | Array of String | 负载均衡监听器ID列表。 示例值:["lbl-4fo6k8na"] |
Protocol | 否 | String | 负载均衡监听的协议:'TCP', 'UDP', 'HTTP', 'HTTPS'。 示例值:TCP |
ListenerPort | 否 | Integer | 负载均衡监听端口,范围为[1-65535]。 示例值:22 |
Status | 否 | Integer | 监听器的状态,0:创建中,1:运行中。 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Listeners | Array of ClassicalListener | 监听器列表。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.FormatError | 参数格式错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Length | 参数长度错误。 |
LimitExceeded | 超过配额限制。 |
ResourceInsufficient | 资源不足。 |
UnauthorizedOperation | 未授权操作。 |
UnsupportedOperation | 操作不支持。 |