clb — Cloud Load Balancer
clb · 2018-03-17
DescribeListeners
POST
Get the list of listeners by CLB ID, listener protocol, or listener port. If no filter is specified, all listeners for the CLB instance will be returned.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /clb/DescribeListeners path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.
curl
curl -sS https://clb.api3.convergecloud.com/ \
-H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/clb/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Host: clb.api3.convergecloud.com' \
-H 'X-TC-Action: DescribeListeners' \
-H 'X-TC-Version: 2018-03-17' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"LoadBalancerId":"<LoadBalancerId>"}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| LoadBalancerId | string | Yes | ID of the cloud load balancer instance. you can call the DescribeLoadBalancers api to obtain the ID. |
| ListenerIds | string[] | No | Specifies the array of clb listener ids to query, with a maximum of 100. you can call the DescribeListeners api to obtain the ids. |
| Protocol | string | No | Type of the listener protocols to be queried. Values: TCP`, `UDP`, `HTTP`, `HTTPS`, `TCP_SSL` and `QUIC`. |
| Port | integer | No | Port of listener to query. value range: 1-65535. |
Response
Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.
| Field | Type | Description |
|---|---|---|
| Listeners | Listener[] | Listener list |
| TotalCount | integer | Total number of listeners (filtered by port, protocol, and listener ID). |
| RequestId | string | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Success
{
"Response": {
"Listeners": …,
"TotalCount": …,
"RequestId": "…"
}
}Error
{
"Response": {
"Error": { "Code": "…", "Message": "…" },
"RequestId": "…"
}
}Try it
CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/clb.
Request bodyvalid JSONPOST clb.api3.convergecloud.com · DescribeListeners
Read-only. Creates nothing.