LoadBalancerDetails

1. API Description

This API is used to query the details of one or more load balancer instances. You can filter the query results with the instance ID or zone.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
loadBalancerIds	No	Array of String	Load balancer instance IDs.
zoneId	No	String	Zone ID.
loadBalancerName	No	String	Load balancer instance names. Fuzzy search is supported.
pageSize	No	Integer	Number of items in the current page result. Default value: 20; Maximum value: 1000.
pageNum	No	Integer	Number of pages returned. Default value: 1.

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	Number of load balancer instances meeting the filtering conditions.
dataSet	Array of LoadBalancerInfo	Information on a load balancer instance.

4. Code Example

Example

Query load balancer details with instance ID.

POST / HTTP/1.1
Host: console.harmonynetworks.net/api/v2/bmc
Content-Type: application/json
X-ZC-Action: LoadBalancerDetails
<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. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​