DescribeLoadBalancers

1. API Description

This API (DescribeLoadBalancers) is used to query the information of one or more specified load balancing instances. Users can search for load balancer information based on the ID of the load balancer, the zone, and other information.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
loadBalancerIds	No	Array of String	ID list of the load balance instance.
zoneId	No	String	Zone ID.
loadBalancerName	No	String	The name of the load balancer instance. Fuzzy search supported.
pageNum	No	Integer	Number of pages returned. Default value: 1 . Default value: 1
pageSize	No	Integer	Number of items in the current page result. Default value: 20 ; Maximum value: 1000 .
resourceGroupId	No	String	The ID of the resource group.
tagKeys	No	Array of String	Query according to tag key. You can query up to 20 tag keys in each request.
tags	No	Array of Tag	Query according to tag. You can query up to 20 tags in each request.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
totalCount	Integer	The total number of load balancers that meet the filtering conditions.
dataSet	Array of LoadBalancerInfo	Load balancer set.

4. Code Example

Example

Query the information of the load balancer instance by 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. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs，to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code	Error Code	Description