DescribeBandwidth

1. API Description

This interface (DescribeBandwidth) is used to query CDN bandwidth.

Preparations

• Query billing regions: Call DescribeBillingRegions.

2. Request Parameters

The following request parameter list only includes the required parameters for the interface

Parameter Name	Required	Type	Description
startTime	Yes	String	Start time
endTime	Yes	String	End time
domain	No	String	Acceleration domain
region	No	String	Billing region
protocol	No	String	Protocol Type
group	No	String	Group Type

3. Output Parameterss

Parameter Name	Type	Description
dataSet	Array of BandwithData	Bandwidth data
requestId	String	Unique request ID. Each request returns it. Provide this ID when locating problems.

4. Code Example

Example

1. Query CDN bandwidth.

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

Request:
{
}

Response:
{
  "requestId": "T6883FCD0-3E7D-44EA-A517-A421A52A27F4",
  "response": {
    "requestId": "T6883FCD0-3E7D-44EA-A517-A421A52A27F4",
    "dataSet": [{
      "data": [{
        "time": "2022-06-14T00:00:00.000Z",
        "value": 1.4
      },
      {
        "time": "2022-06-14T00:05:00.000Z",
        "value": 1.4
      },
      {
        "time": "2022-06-14T00:10:00.000Z",
        "value": 1.4
      }],
      "domain": "www.ddd123.com",
      "region": "ALL"
    }]
  }
}

5. Error Codes

The following includes error codes encountered in business logic. For other error codes, see Common Error Codes.