Help Center/Content Delivery Network/API Reference/API/Statistical Analysis/Querying Basic Domain Name Statistics
Updated on 2025-11-10 GMT+08:00
View PDF

Querying Basic Domain Name Statistics

Function

  • You can query data within the past 90 days.

  • You can query up to 5 metrics each time.

  • You can query up to 20 domain names each time.

  • The start time and end time must be timestamps in milliseconds and must be exact time points that match the query interval. For example, if the query interval is 5 minutes, the start time and end time must be exact 5-minute intervals, for example, 0 minutes, 5 minutes, 10 minutes, and 15 minutes. If the time points do not match the query interval, the returned data may not be the expected data. If the start time is 2019-01-24 20:15:00 and the query interval is 5 minutes, the statistics in [20:15:00, 20:20:00) are queried.

  • Values of action include detail and summary.

  • Unit: byte for traffic-related metrics, bit/s for bandwidth-related metrics, and number of times for request quantity and status code-related metrics. You can query statistics about specific domain names by specific metrics.

  • A single tenant can call this API 15 times per second.

URI

GET /v1.0/cdn/statistics/domain-stats

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

action

Yes

String

  • Action name. Possible values are summary and detail.

  • summary: querying summary data.

  • detail: querying data details.

start_time

Yes

Long

  • Start timestamp of the query. This parameter must be specified together with the end timestamp. The query interval is left-closed and right-open.

  • If the value of interval is 300, set this parameter to a multiple of 5 minutes, for example, 1631240100000 (2021-09-10 10:15:00).

  • If the value of interval is 3600, set this parameter to a multiple of 1 hour, for example, 1631239200000 (2021-09-10 10:00:00).

end_time

Yes

Long

  • End timestamp of the query. This parameter must be specified together with the start timestamp. The query interval is left-closed and right-open.

  • If the value of interval is 300, set this parameter to a multiple of 5 minutes, for example, 1631243700000 (2021-09-10 11:15:00).

  • If the value of interval is 3600, set this parameter to a multiple of 1 hour, for example, 1631325600000 (2021-09-11 10:00:00).

domain_name

Yes

String

Domain name list. Use commas (,) to separate multiple domain names, for example, www.test1.com,www.test2.com.

all indicates that all domain names are queried.

stat_type

Yes

String

  • Network resource consumption statistics:

    • bw (bandwidth)

    • flux (traffic)

    • bs_bw (pull bandwidth)

    • bs_flux (pull traffic)

    • hit_flux (traffic generated by requests that hit the caches)

  • Access statistics:

    • req_num (number of requests)

    • bs_num (number of pull requests)

    • bs_fail_num (number of failed pull requests)

    • hit_num (number of hits)

  • HTTP status code statistics (one or more types can be returned):

    • http_code_2xx (status codes 2xx)

    • http_code_3xx (status codes 3xx)

    • http_code_4xx (status codes 4xx)

    • http_code_5xx (status codes 5xx)

interval

No

Long

  • Query interval, in seconds.

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

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

  • If this parameter is not passed, the system uses the smallest value corresponding to the queried time span by default.

group_by

No

String

Data grouping mode. This parameter can be set to domain. By default, data is not grouped.

service_area

Yes

String

europe: Europe. asia_pacific_1: Asia Pacific 1, including Japan, South Korea, Hong Kong (China), Macao (China), and Taiwan (China). asia_pacific_2: Asia Pacific 2, including India. asia_pacific_3: Asia Pacific 3, including other regions in Asia Pacific. me_africa: Middle East and Africa. north_america: North America. oceania: Oceania. south_america: South America. This parameter is invalid when retrieval metrics are queried. In Europe, Asia Pacific 1, Asia Pacific 2, Asia Pacific 3, Middle East and Africa, North America, Oceania, and South America, only flux (traffic), bw (bandwidth), and req_num (number of requests) can be queried. HTTP status code metrics http_code_2xx, http_code_3xx, http_code_4xx, and http_code_5xx can be queried only in the global region.

enterprise_project_id

No

String

ID of the enterprise project to which the resource belongs. 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.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

result

Map<String,Object>

Data organized according to the specified grouping mode.

Status code: default

Table 3 Response body parameters

Parameter

Type

Description

error

ErrMsg object

Error code and error message.

Table 4 ErrMsg

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

  • Ungrouped details

    GET https://cdn.myhuaweicloud.eu/v1.0/cdn/statistics/domain-stats?action='summary'&start_time=1667030400000&end_time=1667116800000&domain_name='www.test1.com'&stat_type='flux'&interval=300&service_area='europe'&enterprise_project_id='all'

  • Details by domain

    GET https://cdn.myhuaweicloud.eu/v1.0/cdn/statistics/domain-stats?action='summary'&start_time=1667030400000&end_time=1667116800000&domain_name='www.test1.com'&stat_type='flux'&interval=300&group_by='domain'&service_area='europe'&enterprise_project_id='all'

Example Responses

Status code: 200

Success response

  • Ungrouped details

    {
  "result" : {
    "flux" : [ 1000, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ]
  }
}

  • Details by domain

    {
  "result" : {
    "www.test1.com" : {
      "req_num" : [ 118, 105, 113, 115, 114, 111, 106, 108, 118, 94, 97, 113 ]
    },
    "www.test2.com" : {
      "req_num" : [ 118, 105, 113, 115, 114, 111, 106, 108, 118, 94, 97, 113 ]
    }
  }
}

Status Codes

Status Code

Description

200

Success response

default

Abnormal response

Error Codes

See Error Codes.