Querying Consumption Summary
You can query data within the past 90 days.
The time span ranges from 1 hour to 31 days.
You can specify up to 100 domain names at a query.
The start time and end time must be specified at the same time. Their values must be precise down to the millisecond, but exact, one hour or one day (00:00:00) intervals are allowed. If the time span is less than 7 days, the time granularity must be one hour, for example, 2020-07-01 08:00:00 and 2020-07-01 09:00:00. If the time span is longer than 7 days but shorter than 31 days, the time granularity must be a whole day, for example, 2020-07-01 00:00:00 and 2020-07-02 00:00:00.
If the start time and end time do not meet the requirements, the returned data may be different from what was expected.
Function
This API is used to query summary information about specific domain names within a time range.
URI
GET /v1.0/cdn/statistics/domain-summary
Request
Request parameters
Table 1 describes the request parameters.
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
start_time |
No |
Long |
Query start timestamp, in milliseconds. |
end_time |
No |
Long |
Query end timestamp, in milliseconds. |
domain_name |
Yes |
String |
Domain name list. Use commas (,) to separate domain names, for example, www.test1.com,www.test2.com. The value ALL indicates that all domain names under a tenant are queried. |
stat_type |
Yes |
String |
Types of statistics: bw (bandwidth), flux (traffic), bs_bw (origin pull bandwidth), bs_flux (origin pull traffic), req_num (total number of requests), req_hit_rate (cache hit ratio), flux_hit_rate (traffic hit ratio), bs_fail_rate (origin pull failure rate), qps (requests per second), http_code_2xx (status code 2xx), http_code_3xx (status code 3xx), http_code_4xx (status code 4xx), and http_code_5xx (status code 5xx). |
service_area |
No |
String |
Valid values are mainland_china and outside_mainland_china. The default value is mainland_china. You cannot query origin pull metrics including bs_flux, bs_bw, and bs_fail_rate by service area. |
enterprise_project_id |
No |
String |
Enterprise project that the resource belongs to. This parameter is valid only when the enterprise project function is enabled. The value all indicates all projects. This parameter is mandatory when you use an IAM user to call this API. |
Example request
Requested path
GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/domain-summary?start_time=1513094400000&end_time=1513180799346&domain_name=example3.example2.example1.com&interval=300&stat_type=flux&enterprise_project_id=0
Response
Response parameters
Table 2 describes the response parameter.
Parameter |
Type |
Description |
---|---|---|
domain_summary |
Object |
Queried data objects. For details, see Table 3. |
domain_summary parameter description
Parameter |
Type |
Description |
---|---|---|
start_time |
Integer |
Query start timestamp, in milliseconds. |
end_time |
Integer |
Query end timestamp, in milliseconds. |
value |
Integer |
Total value of a metric (traffic unit: byte; bandwidth unit: bit/s). |
stat_type |
String |
Statistics type. |
service_area |
String |
Possible values are mainland_china (Chinese mainland) and outside_mainland_china (outside the Chinese mainland). You cannot query origin pull metrics by service area. |
{ "domain_summary": { "value": 835038584, "start_time": 1513094400000, "end_time": 1513180799346, "stat_type": "flux", "service_area": "mainland_china" } }
Status Codes
See Status Codes.
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