ServerPoolDetails

1. API Description

The API is used to query the details of one or more backend servers. You can filter the query results with the listener ID or backend server ID.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
listenerId	Yes	String	Listener ID.
backendIds	No	Array of String	Backend server IDs.
backendName	No	String	Backend server name.
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 backend servers meeting the filtering conditions.
dataSet	Array of BackendInfo	Information on a backend server.

4. Code Example

Example

Query the details of backend server list according to the listener ID.

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

Request:
{
  "listenerId": "xxxx"
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "totalCount": 10,
    "dataSet": [
      {
        "listenerId": "xxx",
        "backendId": "xxx",
        "backendName": "xxxx",
        "status": "Available",
        "port": "80",
        "weight": 100,
        "instanceId": "xxxx",
        "instanceName": "xxxx",
        "createTime": "2022-08-31 11:13:17"
      }
    ]
  }
}

5. Error Codes

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