Help Center/ Video On Demand/ API Reference/ Historical APIs/ Statistical Analysis/ Querying CDN Statistics - ShowCdnStatistics
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying CDN Statistics - ShowCdnStatistics

Functions

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. The statistics are displayed with a one-hour delay.

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, seePermissions and Supported Actions.

URI

GET /v1.0/{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 the Project ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

start_time

No

String

Start time. The format is yyyymmddhhmmss.

end_time

No

String

End time. The format is yyyymmddhhmmss.

  • If neither start_time nor end_time is specified, start_time defaults to 00:00:00 of the current day, and end_time defaults to the current time.

  • If end_time is set but start_time is not, the request is invalid.

  • If start_time is set but end_time is not, the current time is used as end_time.

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

  • The start time and end time are automatically rounded. The start time is rounded down to the hour, while the end time is rounded up to the next hour.

stat_type

Yes

String

Statistical data type.

Options:

  • cdn_bw: CDN peak bandwidth

  • cdn_flux: CDN traffic

  • req_num: total number of requests

  • req_hit_rate: request hit rate

  • flux_hit_rate: traffic hit rate

Only one type of statistics can be queried at a time.

domain

Yes

String

Domain names. Use commas (,) to separate them.

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

The value ALL indicates that all domain names under the account are queried. A maximum of 100 domain names can be queried at a time.

interval

No

Integer

Query granularity.

Options:

  • For a time span of 1 day, the supported granularities are 300 seconds (5 minutes), 3,600 seconds (1 hour), 14,400 seconds (4 hours), and 28,800 seconds (8 hours).

  • For a time span of 2 to 7 days, the supported granularities are 3,600 seconds (1 hour), 14,400 seconds (4 hours), 28,800 seconds (8 hours), and 86,400 seconds (1 day).

  • For a time span of 8 to 31 days, the supported granularities are 14,400 seconds (4 hours), 28,800 seconds (8 hours), and 86,400 seconds (1 day).

Unit: second

If this parameter is not specified, the minimum granularity for the corresponding time span is used by default.

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.

The token 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 statistic collection.

interval

Integer

Statistics collection interval.

values

Array of longs

Sampled data array.

Sampling starts from start_time, and one data record will be collected at each interval (traffic unit: byte; bandwidth unit: bit/s).

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Request Examples

This example queries CDN statistics.

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

Response Examples

Status code: 200

Returned when the request succeeded.

{
  "start_time" : "string",
  "interval" : 0,
  "values" : [ 0 ]
}

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