查询应用型负载均衡云服务器列表

最近更新时间:2017-12-26 17:39:00

接口描述

DescribeForwardLBBackends 接口用来查询应用型负载均后端绑定的机器列表。

接口访问域名:lb.api.qcloud.com

请求参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。其中,此接口的Action字段为 DescribeForwardLBBackends。

参数名称 必选 类型 描述
loadBalancerId String 负载均衡实例 ID,可通过 DescribeLoadBalancers 接口同时入参 forward 字段为 1 或者 -1 来查询。
listenerIds.n String 应用型负载均衡监听器 ID,可通过 DescribeForwardLBListeners 接口查询。
protocol Int 监听器协议类型,1:HTTP,2:TCP,3:UDP,4:HTTPS。
loadBalancerPort Int 负载均衡监听器端口。

返回参数

参数名称 类型 描述
code Int 公共错误码, 0 表示成功,其他值表示失败。详见错误码页面的 公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误码,成功返回 Success,失败有相应的英文说明。
data Array 返回的数组。

data数组结构:

参数名称 类型 描述
listenerId String 监听器 ID。
protocol Int 监听器的协议。1:HTTP,2:TCP,3:UDP,4:HTTPS。
protocolType String 监听器的协议。例如 HTTP。
loadBalancerPort Int 监听器的监听端口。
rules Array 七层监听器下的转发规则组。
backends Array 四层监听器下的云服务器的信息。

rules 数组结构:

参数名称 类型 描述
locationId String 转发规则的 ID。
domain String 转发规则的域名。
url String 转发规则的路径。
backends Array 后端云服务器的信息。

backends 数组结构:

参数名称 类型 描述
lanIp String 云服务器的内网 IP。
wanIpSet Array 云服务器的外网 IP。
port Int 云服务器的服务端口。
weight Int 云服务器的权重。
instanceStatus Int 云服务器的状态。
unInstanceId String 云服务器的 ID。
instanceName String 云服务器的名称。
addTimestamp String 云服务器绑定的时间。

示例

请求

https://lb.api.qcloud.com/v2/index.php?Action=DescribeForwardLBBackends
&<公共请求参数>
&loadBalancerId=lb-abcdefgh

返回

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": [
        {
            "loadBalancerPort": 80,
            "protocol": 1,
            "protocolType": "http",
            "listenerId": "lbl-fh7o7bgt",
            "rules": [
                {
                    "locationId": "loc-7w5sp6wf",
                    "backends": [
                        {
                            "instanceName": "拨测机器,请勿删除",
                            "lanIp": "10.212.199.17",
                            "wanIpSet": [
                                "45.113.71.7"
                            ],
                            "instanceStatus": 0,
                            "port": 80,
                            "weight": 10,
                            "unInstanceId": "ins-42lrdi7x",
                            "addTimestamp": "2016-11-03 11:21:38"
                        },
                        {
                            "instanceName": "拨测机器,请勿删除",
                            "lanIp": "10.212.199.17",
                            "wanIpSet": [
                                "45.113.71.7"
                            ],
                            "instanceStatus": 0,
                            "port": 443,
                            "weight": 10,
                            "unInstanceId": "ins-42lrdi7x",
                            "addTimestamp": "2016-11-03 11:21:38"
                        }
                    ],
                    "domain": "www.baidu.com",
                    "url": "/second"
                },
                {
                    "locationId": "loc-3n8v5v5b",
                    "backends": [
                        {
                            "instanceName": "拨测机器,请勿删除",
                            "lanIp": "10.212.199.17",
                            "wanIpSet": [
                                "45.113.71.7"
                            ],
                            "instanceStatus": 0,
                            "port": 80,
                            "weight": 10,
                            "unInstanceId": "ins-42lrdi7x",
                            "addTimestamp": "2016-11-03 11:21:38"
                        },
                        {
                            "instanceName": "拨测机器,请勿删除",
                            "lanIp": "10.212.199.17",
                            "wanIpSet": [
                                "45.113.71.7"
                            ],
                            "instanceStatus": 0,
                            "port": 443,
                            "weight": 10,
                            "unInstanceId": "ins-42lrdi7x",
                            "addTimestamp": "2016-11-03 11:21:38"
                        }
                    ],
                    "domain": "www.baidu.com",
                    "url": "/first"
                }
            ]
        }
    ]
}