DescribeBackends

1. API Description

This API (DescribeBackends) is used to query the information of one or more specified backend servers. Users can search for backend server information based on the ID of the listener, the ID of the backend server, and other information.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
listenerId	Yes	String	The listener ID.
backendIds	No	Array of String	ID list of backend servers.
backendName	No	String	Backend server name.
instanceType	No	InstanceProductType	Instance type. Default value: BM
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 .

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 backend servers that meet the filtering conditions.
dataSet	Array of BackendInfo	Backend server list.

4. Code Example

Example

Get a list of all backend servers based on the listener ID.

POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeBackends
<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. 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