ListenerDetails

1. API Description

The API is used to query the details of one or more listeners. You can filter the query results with the load balancer instance ID or listener ID.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
listenerIds	No	Array of String	Listener ID list. Up to 100 IDs are supported.
loadBalancerIds	Yes	Array of String	Load balancer instance ID list. Up to 100 IDs are supported.
listenerName	No	String	Listener name. 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 listeners meeting the filtering conditions.
dataSet	Array of ListenerInfo	Information on a listener.

4. Code Example

Example

Query the details of listeners according to the load balancer instance ID.

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

Request:
{
  "loadBalancerIds": ["xxxx"]
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "totalCount": 10,
    "dataSet": [
      {
        "listenerId": "xxxxx",
        "listenerName": "xxxx",
        "status": "Available",
        "port": "80",
        "protocol": "TCP",
        "backendProtocol": "TCP",
        "scheduler": "rr",
        "kind": "DR",
        "loadBalancerId": "xxxx",
        "createTime": "2022-08-31 11:11:20"
      }
    ]
  }
}

5. Error Codes

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