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. 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, see Permissions Policies and Supported Actions.
URI
GET /v1.0/{project_id}/asset/cdn-statistics
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
start_time |
No |
String |
Start time. The format is yyyymmddhhmmss. |
|
end_time |
No |
String |
End time. The format is yyyymmddhhmmss.
|
|
stat_type |
Yes |
String |
Statistics type. The options include:
Only one type of statistics can be queried at a time. |
|
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 100 domain names can be queried at a time. |
|
interval |
No |
Integer |
Query granularity. The options include:
Unit: second If this parameter is not specified, the minimum granularity for the corresponding time span is used by default. |
Request 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
|
Parameter |
Type |
Description |
|---|---|---|
|
start_time |
String |
Start time for statistics 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
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error description. |
Example Requests
This example queries CDN statistics.
GET https://{endpoint}/v1.0/{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" : "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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot