接口描述
DescribeLBHealthStatus 接口用来查询负载均衡实例的健康检查相关参数。
接口访问域名:lb.api.qcloud.com
请求参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为 DescribeLBHealthStatus。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
loadBalancerId | 是 | String | 负载均衡实例 ID,可通过 DescribeLoadBalancers 接口查询。 |
listenerId | 否 | String | 负载均衡监听器 ID, 可通过 DescribeLoadBalancerListeners 接口查询。 |
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码,0表示成功,其他值表示失败。详情请参见 公共错误码。 |
message | String | 模块错误信息描述,与接口相关。 |
codeDesc | String | 英文错误码,成功返回 Success,失败有相应的英文说明。 |
data | Array | 返回的数组。 |
Data数组结构:
参数名称 | 类型 | 描述 |
---|---|---|
ip | String | 云服务器内网 IP。 |
protocol | String | 协议。 |
port | Int | 云服务器端口。 |
vport | Int | 负载均衡监听端口。 |
healthStatus | Int | 健康检查结果,1表示健康,0表示不健康。 |
示例
请求示例
https://lb.api.qcloud.com/v2/index.php?Action=DescribeLBHealthStatus &<公共请求参数> &loadBalancerId=lb-abcdefgh
返回示例
{
"code":0,
"message" : "",
"codeDesc": "Success",
"data":[
{
"ip":"10.2.3.0",
"protocol":"TCP",
"port":8001,
"vport":8001,
"healthStatus":0
}
]
}