clb — Cloud Load Balancer
clb · 2018-03-17
DescribeLoadBalancers
POST
Query the list of CLB instances in a region.
Wire call
Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /clb/DescribeLoadBalancers 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: DescribeLoadBalancers' \
-H 'X-TC-Version: 2018-03-17' \
-H 'X-TC-Timestamp: <unix-seconds>' \
-H 'X-TC-Region: luzon' \
-d '{"Offset":0,"Limit":20}'Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| LoadBalancerIds | string[] | — | CLB instance IDs. There can be up to 20 IDs. |
| LoadBalancerType | string | — | CLB instance network type: |
| Forward | integer | — | CLB instance type. 1: generic CLB instance; 0: classic CLB instance |
| LoadBalancerName | string | — | Specifies the name of the clb instance. fuzzy query is supported. |
| Domain | string | — | Converge Cloud assigns a domain name to the cloud load balancer instance. fuzzy query is supported. |
| LoadBalancerVips | string[] | — | VIP address of a CLB instance (there can be multiple addresses) |
| BackendPublicIps | string[] | — | Public IPs of the backend services bound with the load balancer. Only the public IPs of CVMs are supported now. |
| BackendPrivateIps | string[] | — | Private IPs of the backend services bound with the load balancer. Only the private IPs of CVMs are supported now. |
| Offset | integer | — | Data offset. Default value: 0. |
| Limit | integer | — | Number of returned CLB instances. Default value: 20. Maximum value: 100. |
| OrderBy | string | — | Sorting parameter. supports the following fields:. |
| OrderType | integer | — | 1 for descending, 0 for ascending, defaults to 1, sorted by creation time in descending order. |
| SearchKey | string | — | Specifies the fuzzy search field for fuzzy matching the name, domain name, VIP address, or ID of a cloud load balancer instance. |
| ProjectId | integer | — | Project ID of the cloud load balancer instance. you can call the DescribeProject api to obtain the ID. defaults to all projects if not passed. |
| WithRs | integer | — | Whether a CLB instance is bound to a real server. 0: no; 1: yes; -1: query all. |
| VpcId | string | — | Specifies the unique vpc ID of the load balancing instance, such as vpc-bhqkbhdx. you can call the DescribeVpcs api to obtain it. |
| SecurityGroup | string | — | Security group ID, such as sg-m1cc****, can be obtained through the API DescribeSecurityGroups. |
| MasterZone | string | — | Primary availability zone ID, such as 100001 (corresponding to Guangzhou Zone 1). You can obtain the list of availability zones through DescribeZones. |
| Filters | Filter[] | — | Each request can have up to 10 `Filters` and 100 `Filter.Values`. Detailed filter conditions: |
| AdditionalFields | string[] | — | Specifies the expanded fields to return. not specified, expanded fields do not return by default. supported expanded fields are as follows:. |
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 |
|---|---|---|
| TotalCount | integer | Total number of CLB instances that meet the filter criteria. This value is independent of the Limit in the input parameter. |
| LoadBalancerSet | LoadBalancer[] | Array of returned CLB instances. |
| 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": {
"TotalCount": …,
"LoadBalancerSet": …,
"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 · DescribeLoadBalancers
Read-only. Creates nothing.
Recorded example response
{
"Response": {
"TotalCount": 0,
"LoadBalancerSet": [],
"RequestId": "1dc4ca06-ca6d-b00f-08f0-9a9ff65fcc59"
}
}