DescribeBandwidthClusterUsage

1. API Description

This API (DescribeBandwidthClusterUsage) is used to Query usage information for a bandwidth cluster.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
bandwidthClusterId	Yes	String	ID of bandwidth cluster.
pageSize	No	Integer	The returned page size. Default value: 20.
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 results meeting the filtering conditions. Default value: 0
dataSet	Array of BandwidthClusterUsageData	Bandwidth usage dataset. Default value: []

4. Code Example

Example

**1. Query usage information for a bandwidth cluster. **

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

Request：
{
  "bandwidthClusterId": "bandwidthClusterId",
  "pageNum": 1,
  "pageSize": 20
}

Response：
{
  "requestId": "T4C35327C-7B13-47B8-A815-5E5213D4A9F9",
  "response": {
    "requestId": "T4C35327C-7B13-47B8-A815-5E5213D4A9F9",
    "totalCount": 30,
    "dataSet": [
      {
        "time": "2024-01-01",
        "value": 100.50,
        "details": [
          {
            "cityName": "Los Angeles",
            "cityCode": "LAX",
            "product": "BMC",
            "value": 50.25
          },
          {
            "cityName": "Singapore",
            "cityCode": "SIN",
            "product": "BMC",
            "value": 50.25
          }
        ]
      },
      {
        "time": "2024-01-02",
        "value": 120.80,
        "details": [
          {
            "cityName": "Los Angeles",
            "cityCode": "LAX",
            "product": "BMC",
            "value": 60.40
          },
          {
            "cityName": "Singapore",
            "cityCode": "SIN",
            "product": "BMC",
            "value": 60.40
          }
        ]
      }
    ]
  }
}

5. 5. Developer Resources

Zenlayer Cloud API 2.0 integratesSDKs，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, seeCommon Error Codes.

HTTP Status Code	Error Code	Description
404	INVALID_CLUSTER_NOT_FOUND	Bandwidth cluster does not exist.