DescribeBandwidth

1. API Description

This interface (DescribeBandwidth) is used to query CDN bandwidth, data aggregation internval is 5 minutes.

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	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
endTime	Yes	String	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note: The end time must be later than the start time.
domain	No	String	domain, use commas(,) to separate multiple domain names. By default, all acceleration domains will be queried.
region	No	String	Billing region
protocol	No	String	Protocol Type

3. Output Parameterss

Parameter Name	Type	Description
dataSet	Array of BandwithData	Bandwidth data(Unit Mbps)
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:
{
    "startTime": "2024-08-22T00:00:00Z",
    "endTime": "2024-08-22T01:00:00Z"
}

Response:
{
    "requestId": "T72DC2D08-XXXX-XXXX-XXXX-60567E6E53B8",
    "dataSet": [
        {
            "data": [
                {
                    "time": "2024-08-22T00:00:00Z",
                    "value": 4173.58
                },
                {
                    "time": "2024-08-22T00:05:00Z",
                    "value": 4792.3
                },
                {
                    "time": "2024-08-22T00:10:00Z",
                    "value": 4105.91
                },
                {
                    "time": "2024-08-22T00:15:00Z",
                    "value": 4373.59
                },
                {
                    "time": "2024-08-22T00:20:00Z",
                    "value": 5101.28
                },
                {
                    "time": "2024-08-22T00:25:00Z",
                    "value": 5980.99
                },
                {
                    "time": "2024-08-22T00:30:00Z",
                    "value": 5934.21
                },
                {
                    "time": "2024-08-22T00:35:00Z",
                    "value": 6283.05
                },
                {
                    "time": "2024-08-22T00:40:00Z",
                    "value": 6121.99
                },
                {
                    "time": "2024-08-22T00:45:00Z",
                    "value": 6609.52
                },
                {
                    "time": "2024-08-22T00:50:00Z",
                    "value": 6191.17
                },
                {
                    "time": "2024-08-22T00:55:00Z",
                    "value": 5513.65
                },
                {
                    "time": "2024-08-22T01:00:00Z",
                    "value": 5434.91
                }
            ],
            "domain": "www.xxx.com",
            "region": "ALL"
        }
    ]
}

5. Error Codes

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