Doc CenterSign in to zenConsole

DescribeBandwidthClusters

1. API Description

This API is used to query information of one or more bandwidth clusters. You can filter the query results with bandwidth cluster ID, name, city name and etc.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

bandwidthClusterIds

No

Array of String

Bandwidth cluster ID.

You can query up to 100 IDs in each request.

bandwidthClusterName

No

String

Bandwidth cluster name. Fuzzy search is supported.

cityName

No

String

Name of city included in the bandwidth cluster.

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 bandwidth clusters meeting the filtering conditions.

dataSet

Information on bandwidth clusters.

4. Code Example

Query bandwidth cluster list.

POST /api/v2/traffic HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeBandwidthClusters
<Common Request Params>

Request:
{
  "pageNum": 1,
  "pageSize": 1
}

Response:
{
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "response": {
        "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
        "totalCount": 1,
        "dataSet": [
            {
                "bandwidthClusterId": "bandwidthClusterId",
                "bandwidthClusterName": "Frankfurt",
                "location": "Frankfurt",
                "createTime": "2024-01-01T00:00:00Z"
            }
        ]
    }
}

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

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

Last updated