1. 接口描述
接口请求域名: clb.tencentcloudapi.com 。
获取目标组绑定的服务器信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTargetGroupInstances。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Filters.N | 是 | Array of Filter | 过滤条件,当前仅支持TargetGroupId,BindIP,InstanceId过滤。 |
Limit | 否 | Integer | 显示数量限制,默认20。 示例值:20 |
Offset | 否 | Integer | 显示的偏移量,默认为0。 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 本次查询的结果数量。 示例值:2 |
TargetGroupInstanceSet | Array of TargetGroupBackend | 绑定的服务器信息。 |
RealCount | Integer | 实际统计数量,不受Limit、Offset、CAM的影响。 示例值:2 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 显示目标组绑定的服务器信息
显示目标组绑定的服务器信息
输入示例
https://clb.tencentcloudapi.com/?Action=DescribeTargetGroupInstances
&Filters.0.Name=TargetGroupId
&Filters.0.Values.0=lbtg-5xunivs0
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 2,
"TargetGroupInstanceSet": [
{
"TargetGroupId": "lbtg-5xunivs0",
"Type": "CVM",
"InstanceId": "ins-197234qt",
"InstanceName": "未命名",
"Port": 3333,
"Weight": 43,
"PublicIpAddresses": [],
"PrivateIpAddresses": [
"172.16.0.32"
],
"EniId": null,
"RegisteredTime": "2019-07-24 20:02:43"
},
{
"TargetGroupId": "lbtg-5xunivs0",
"Type": "CVM",
"InstanceId": "ins-197234qt",
"InstanceName": "未命名",
"Port": 2222,
"Weight": 55,
"PublicIpAddresses": [],
"PrivateIpAddresses": [
"172.16.0.32"
],
"EniId": null,
"RegisteredTime": "2019-07-23 21:01:08"
}
],
"RealCount": 2,
"RequestId": "94240d7f-8bc1-422a-81b9-5ea76d486a66"
}
}
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 | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
UnauthorizedOperation | 未授权操作。 |