DescribeLoadBalancers

1. 接口描述

本接口用于查询负载均衡实例列表。

2. 请求参数

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

参数名称	必选	类型	描述
regionId	否	String	节点ID。
vpcId	否	String	根据负载均衡后端服务器所属的VPC网络 ID过滤。
loadBalancerIds	否	Array of String	负载均衡实例ID集合。 实例ID数量上限为100个。
loadBalancerName	否	String	负载均衡实例名称。 可以在末尾加入*以支持模糊匹配。
pageSize	否	Integer	返回的分页大小。 默认为20，最大为1000。
pageNum	否	Integer	返回的分页页码。 默认为1。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
totalCount	Integer	满足过滤条件的负载均衡实例总数。
dataSet	Array of LoadBalancer	返回的负载均衡实例列表。

4. 代码示例

示例

1. 查看负载均衡实例列表。

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

Request：
{
}

Response：
{
    "requestId": "TC073A2C6-3923-48AD-960F-446CBF303A2A",
    "response": {
        "requestId": "TC073A2C6-3923-48AD-960F-446CBF303A2A",
        "totalCount": 6,
        "dataSet": [
            {
                "loadBalancerId": "<loadBalancerId>",
                "listenerCount": 0,
                "regionId": "asia-east-1",
                "publicIpAddress": [
                    "128.xx.xx.1"
                ],
                "createTime": "2025-04-01T01:01:01Z",
                "loadBalancerName": "sample-load-balancer",
                "vpcId": "<vpcId>",
                "status": "RUNNING"
              }
        ]
    }
}

5. 开发者工具

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

6. 错误码

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