接口描述
DescribeForwardLBHealthStatus 接口用来查询负载均衡实例的健康检查结果。
接口访问域名:
lb.api.qcloud.com
请求参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为 DescribeForwardLBHealthStatus。
参数名称 | 必选 | 类型 | 描述 |
loadBalancerIds.n | 是 | String |
返回参数
参数名称 | 类型 | 描述 |
code | Int | |
message | String | 模块错误信息描述,与接口相关。 |
codeDesc | String | 英文错误码,成功返回 Success,失败有相应的英文说明。 |
data | Array | 返回的数组。 |
data 数组结构:
参数名称 | 类型 | 描述 |
loadBalancerName | String | 负载均衡的名称。 |
loadBalancerId | String | 负载均衡的 ID。 |
unLoadBalancerId | String | 负载均衡的 ID,与 loadBalancerId 一致。 |
listener | Array | 监听器数组。 |
listener 数组结构:
参数名称 | 类型 | 描述 |
listenerId | String | 负载均衡监听器 ID。 |
protocol | Int | 负载均衡监听器的协议类型。1:HTTP 协议,4:HTTPS 协议。 |
loadBalancerPort | Int | 负载均衡监听器的监听端口。 |
listenerName | String | 负载均衡监听器的名字。 |
rules | Array | 负载均衡监听器下的转发规则组。 |
rules 数组结构:
参数名称 | 类型 | 描述 |
locationId | String | 负载均衡监听器的转发规则 ID。 |
domain | String | 负载均衡监听器的转发规则域名。 |
url | String | 负载均衡监听器的转发规则路径。 |
backends | Array | 后端云服务器数组。 |
backends 数组结构:
参数名称 | 类型 | 描述 |
ip | String | 云服务器的内网 IP。 |
port | Int | 云服务器的服务端口。 |
healthStatus | Int | 健康检查结果,1:健康,0:不健康。 |
示例
请求
https://lb.api.qcloud.com/v2/index.php?Action=DescribeForwardLBHealthStatus&<公共请求参数>&loadBalancerIds.0=lb-6efswuxa
返回
{"code": 0,"message": "","codeDesc": "Success","data": [{"loadBalancerName": "123","loadBalancerId": "lb-6efswuxa","unLoadBalancerId": "lb-6efswuxa","listener": [{"listenerId": "lbl-fh7o7b9o","listenerName": "lna","protocol": 1,"loadBalancerPort": 9090,"rules": [{"locationId": "loc-3n8v5uy6","domain": "*.alibaba.com","url": "/second","backends": [{"ip": "172.17.8.4","port": 80,"healthStatus": 1}]},{"locationId": "loc-7h3nl8dc","domain": "*.alibaba.com","url": "/first","backends": [{"ip": "172.17.8.4","port": 80,"healthStatus": 1}]},{"locationId": "loc-3mkbad8s","domain": "~^.baidu.com","url": "/second","backends": [{"ip": "172.17.8.4","port": 80,"healthStatus": 1}]},{"locationId": "loc-pt6nsy2q","domain": "~^.domain.edu.cn$","url": "/1234&#","backends": [{"ip": "172.17.8.4","port": 80,"healthStatus": 1}]},{"locationId": "loc-h3wu30tc","domain": ".emaoe.com","url": "/1234&#","backends": [{"ip": "172.17.8.4","port": 80,"healthStatus": 1}]},{"locationId": "loc-78ifmow4","domain": ".example.com","url": "/1234&#","backends": [{"ip": "172.17.8.4","port": 80,"healthStatus": 1}]}]}]}]}