1. 接口描述
接口请求域名: ecm.tencentcloudapi.com 。
查询负载均衡绑定的后端服务列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTargets。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-19。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
LoadBalancerId | 是 | String | 负载均衡实例 ID |
ListenerIds.N | 否 | Array of String | 监听器 ID列表 |
Protocol | 否 | Integer | 监听器协议类型 |
Port | 否 | Integer | 监听器端口 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Listeners | Array of ListenerBackend | 监听器后端绑定的机器信息 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询负载均衡绑定的后端服务列表
输入示例
https://ecm.tencentcloudapi.com/?Action=DescribeTargets
&LoadBalancerId=lb-f9zyj3kb
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "cbc4f5bf-589e-4102-a608-bef958372313",
"Listeners": [
{
"Targets": [],
"ListenerId": "lbl-43jbp1cc",
"Port": 12345,
"Protocol": "TCP"
},
{
"Targets": [],
"ListenerId": "lbl-aznj4uuk",
"Port": 222,
"Protocol": "TCP"
},
{
"Targets": [
{
"EniId": "eni-i0qls00b",
"InstanceName": "",
"InstanceId": "ein-nu5sp1s4",
"PublicIpAddresses": [
"101.67.8.124"
],
"Port": 23001,
"RegisteredTime": "2020-08-12 16:08:15",
"Weight": 100,
"PrivateIpAddresses": [
"172.16.0.74"
]
},
{
"EniId": "eni-55sj7ug9",
"InstanceName": "低调的测试机",
"InstanceId": "ein-dqvc6c5g",
"PublicIpAddresses": [
"101.67.8.111"
],
"Port": 23001,
"RegisteredTime": "2020-08-12 16:08:15",
"Weight": 100,
"PrivateIpAddresses": [
"172.16.0.11"
]
}
],
"ListenerId": "lbl-o0hptbhg",
"Port": 13001,
"Protocol": "TCP"
},
{
"Targets": [
{
"EniId": "eni-i0qls00b",
"InstanceName": "",
"InstanceId": "ein-nu5sp1s4",
"PublicIpAddresses": [
"101.67.8.124"
],
"Port": 23002,
"RegisteredTime": "2020-08-12 16:10:41",
"Weight": 100,
"PrivateIpAddresses": [
"172.16.0.74"
]
},
{
"EniId": "eni-i0qls00b",
"InstanceName": "",
"InstanceId": "ein-nu5sp1s4",
"PublicIpAddresses": [
"101.67.8.124"
],
"Port": 23012,
"RegisteredTime": "2020-08-12 16:10:41",
"Weight": 100,
"PrivateIpAddresses": [
"172.16.0.74"
]
}
],
"ListenerId": "lbl-jruukfae",
"Port": 13002,
"Protocol": "TCP"
},
{
"Targets": [],
"ListenerId": "lbl-6p9gf1nq",
"Port": 13003,
"Protocol": "TCP"
}
]
}
}
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.InternalOperationFailure | 内部操作错误。 |
InvalidParameter.FormatError | 参数格式错误。 |
InvalidParameter.InvalidDataFormat | 数据格式不正确。 |
InvalidParameterValue.InvalidPublicParam | 公共参数不合法。 |
InvalidParameterValue.Length | 参数长度错误。 |
UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |