DescribeLoadBalancers

1. 接口描述

调用本接口用于查询一台或多台指定负载均衡实例的信息。用户可以根据负载均衡实例的ID、可用区等信息来搜索负载均衡实例的信息。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称

必选

类型

描述

loadBalancerIds

否

Array of String

负载均衡实例ID集合。

zoneId

否

String

可用区 ID。

loadBalancerName

否

String

负载均衡实例的名称。支持模糊搜索。

pageSize

否

Integer

返回的分页大小。默认为20，最大为1000。

pageNum

否

Integer

返回的分页数。默认为1。

3. 响应结果

参数名称

类型

描述

requestId

String

唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。

totalCount

Integer

符合条件的LB总数量。

dataSet

Array of LoadBalancerInfo

LoadBalancer集合。

4. 代码示例

根据ID查询负载均衡实例的信息。

POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeLoadBalancers
<Common Request Params>

Request:
{
  "loadBalancerIds": ["xxxx"]
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "totalCount": 10,
    "dataSet": [
      {
        "loadBalancerId": "xxx",
        "zoneId": "AMS-A",
        "loadBalancerName": "xxx",
        "specName": "xxx",
        "chargeType": "POSTPAID",
        "createTime": "",
        "status": "RUNNING",
        "resourceGroupId": "xxx",
        "resourceGroupName": "xxx",
        "masterIp": "xxxx",
        "salveIp": "xxx",
        "ipType": "IPv4"
      }
    ]
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

最后更新于1年前