接口描述
DescribeLoadBalancerBackends 接口可以根据负载均衡实例的 ID 查看该负载均衡实例后端绑定的云服务器列表。
访问域名接口:lb.api.qcloud.com
请求参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为 DescribeLoadBalancerBackends。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
loadBalancerId | 是 | String | 负载均衡实例 ID,可通过 DescribeLoadBalancers 接口查询。 |
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码,0表示成功,其他值表示失败。详见错误码页面的 公共错误码。 |
message | String | 模块错误信息描述,与接口相关。 |
codeDesc | String | 英文错误码,成功返回 Success,失败有相应的英文说明。 |
totalCount | Int | 返回该负载均衡实例绑定的云服务器总数。 |
backendSet | Array | 返回的后端服务器数组。 |
backendSet 数组结构:
参数名称 | 类型 | 描述 |
---|---|---|
instanceId | String | 云服务器实例 ID。 |
unInstanceId | String | 云服务器实例 ID,可以代替 instanceId 作任何操作,建议使用此 ID。 |
weight | Int | 云服务器权重。 |
instanceName | String | 云服务器的名称。 |
lanIp | String | 云服务器的内网 IP。 |
wanIpSet | Array | 云服务器的外网 IP。 |
instanceStatus | Int | 云服务器状态 1:故障,2:运行中,3:创建中,4:已关机,5:已退还,6:退还中, 7:重启中,8:开机中,9:关机中,10:密码重置中,11:格式化中,12:镜像制作中,13:带宽设置中,14:重装系统中,19:升级中,21:热迁移中。 |
示例
请求
https://lb.api.qcloud.com/v2/index.php?Action=DescribeLoadBalancerBackends &<公共请求参数> &loadBalancerId=lb-byhpduqt
返回
{
"code": 0,
"message": "",
"codeDesc": "Success",
"totalCount": 1,
"backendSet": [
{
"instanceId": "qcvmed9e93b0bb2784b043c983761e624639",
"unInstanceId": "ins-9o9ex9s0",
"instanceName": "test_k8s_1",
"lanIp": "10.104.222.152",
"wanIpSet": [
"193.112.93.144"
],
"instanceStatus": 4,
"weight": 44
}
]
}