Updated on 2024-05-16 GMT+08:00

Querying Top Domain Names

Function

  • This API is used to query top domain names.
  • You can query data within the past 90 days.
  • The query time span cannot exceed one day.
  • The start time and end time must be both specified. For example, if the start time is 2022-10-24 00:00:00 and end time is 2022-10-25 00:00:00, the statistics in [2022-10-24 00:00:00, 2022-10-25 00:00:00) are queried.
  • The start time and end time must be timestamps in milliseconds at the top of an hour.
  • 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 and details about specific metrics.
  • A single tenant can call this API five times per second.

URI

GET /v1/cdn/statistics/top-domain-names

Table 1 Query parameters

Parameter

Mandatory

Type

Description

start_time

Yes

Long

  • Start timestamp of the query, which must be at the top of an hour.
  • If interval is set to 3600, set start_time to the top of an hour, for example, 1631239200000 (2021-09-10 10:00:00).
  • If interval is set to 86400, set start_time to 00:00:00 GTM+08:00, for example, 1631203200000 (2021-09-10 00:00:00).

end_time

Yes

Long

  • End timestamp of the query, which must be at the top of an hour.
  • If interval is set to 3600, set end_time to the top of an hour, for example, 1631325600000 (2021-09-11 10:00:00).
  • If interval is set to 86400, set end_time to 00:00:00 GTM+08:00, for example, 1631376000000 (2021-09-12 00:00:00).

stat_type

Yes

String

  • Statistics type.
  • Currently, only bw (bandwidth), flux (traffic), and req_num (total number of requests) are supported.

service_area

No

String

Service region. The value can be mainland_china (default) or outside_mainland_china. This parameter is invalid for querying origin pull metrics.

limit

No

Integer

Number of top domain names to be queried. The default value is 20, the maximum value is 500, and the minimum value is 0.

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.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameter

Parameter

Type

Description

top_domain_names

Array of Map<String,Object> objects

Top domain name information.

Status code: default

Table 3 Response body parameter

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 message.

Example Request

GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/top-domain-names?start_time=1667030400000&end_time_1667116800000&stat_type=bw&service_area=mainland_china&limit=100&enterprise_project_id=all

Example Response

{
  "top_domain_names": [
    {
      "domain_name": "www.test1.com",
      "flux": 10000000
    },
    {
      "domain_name": "www.test2.com",
      "flux": 20000000
    },
    {
      "domain_name": "www.test3.com",
      "flux": 30000000
    }
  ]
}

Status Codes

Status Code

Description

200

Success response.

default

Error response.

Error Codes

See Error Codes.