接口请求域名: gwlb.intl.tencentcloudapi.com 。
查询目标组后端服务状态。目前仅支持网关负载均衡类型的目标组支持查询后端服务状态。
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTargetGroupInstanceStatus。 |
| Version | 是 | String | 公共参数,本接口取值:2024-09-06。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TargetGroupId | 是 | String | 目标组唯一id。可通过DescribeTargetGroupList接口获取。 |
| TargetGroupInstanceIps.N | 否 | Array of String | 目标组绑定的后端服务ip列表 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TargetGroupInstanceSet | Array of TargetGroupInstanceStatus | 健康检查后端rs状态列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
批量查询gwlb目标组后端服务状态
POST / HTTP/1.1
Host: gwlb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTargetGroupInstanceStatus
<公共请求参数>
{
"TargetGroupId": "lbtg-3j3****",
"TargetGroupInstanceIps": [
"10.0.1.13",
"10.0.1.5"
]
}
{
"Response": {
"RequestId": "b3ba6587-1a1c-47eb-ac8b-0424bf3fdc86",
"TargetGroupInstanceSet": [
{
"InstanceIp": "10.0.1.13",
"Status": "on"
},
{
"InstanceIp": "10.0.1.5",
"Status": "on"
}
]
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。
文档反馈