Help Center/ Video On Demand/ API Reference/ Statistical Analysis/ Querying CDN Statistics
Updated on 2026-01-16 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying CDN Statistics

Function

This API is used to query CDN statistics, including the traffic volume, peak bandwidth, total number of requests, request hit ratio, and traffic hit ratio.

You can query up to 20 domain names at a time. Each query can include multiple metrics, but no more than five. When you specify a time range, both the start time and end time must be provided together. The start time is inclusive, and the end time is exclusive. For specific parameter constraints, see the parameter descriptions below.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v2/{project_id}/asset/cdn-statistics

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

start_time

Yes

String

Start time. The format is yyyymmddhhmmss.

  • If interval is set to 300, end_time is aligned to a 5-minute boundary, for example, 20240601000000.

  • If interval is set to 3600, end_time is aligned to a full hour, for example, 20240601120000.

  • If interval is set to 86400, end_time is aligned to 00:00:00 GMT+08:00, for example, 20240601000000.

  • Only data from the past three months can be queried, and the time span cannot exceed 31 days.

end_time

Yes

String

End time. The format is yyyymmddhhmmss.

  • If interval is set to 300, end_time is aligned to a 5-minute boundary, for example, 20240601000000.

  • If interval is set to 3600, end_time is aligned to a full hour, for example, 20240601120000.

  • If interval is set to 86400, end_time is aligned to 00:00:00 GMT+08:00, for example, 20240601000000.

  • Only data from the past three months can be queried, and the time range cannot exceed 31 days.

stat_type

Yes

String

Statistics type.

The options include:

  • bw: CDN peak bandwidth

  • flux: CDN traffic

  • req_num: number of requests

  • req_hit_rate: request hit ratio

  • flux_hit_rate: traffic hit ratio

  • http_code_2xx: number of 2xx responses

  • http_code_3xx: number of 3xx responses

  • http_code_4xx: number of 4xx responses

  • http_code_5xx: number of 5xx responses

A maximum of five metrics can be specified. Use commas (,) to separate them.

domain

Yes

String

Domain name list. Use commas (,) to separate domain names.

Example: example.test1.com,example.test2.com

ALL indicates that all domain names under a tenant are queried. A maximum of 20 domain names can be queried at a time.

interval

No

Integer

Query granularity.

The options include:

  • 300 (5 minutes): The maximum query time span is two days.

  • 3600 (1 hour): The maximum query time span is seven days.

  • 86400 (one day): The maximum query time span is 31 days, and the minimum query time span is two days.

Unit: seconds

If this parameter is not set, the default value is 300 for time spans of one day or less, 3600 for time spans greater than one day and up to seven days, and 86400 for time spans greater than seven days.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when a request is sent. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

start_time

String

Start time for statistics collection.

interval

Integer

Sampling interval.

result

Map<String,Array<Integer>>

CDN data query results.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

This example queries CDN statistics.

GET https://{endpoint}/v2/{project_id}/asset/cdn-statistics?domain=www.example.com&stat_type=cdn_bw

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "start_time" : "20250712000000",
  "interval" : 86400,
  "result" : {
    "bw" : [ 111, 1111, 1111, 1111, 1111, 1111, 1111, 1111, 1111, 11111 ]
  }
}

Status code: 400

Returned when the request failed.

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

Status Codes

Status Code

Description

200

Returned when the request succeeded.

400

Returned when the request failed.

Error Codes

See Error Codes.

Parent topic: Statistical Analysis