Help Center/ Content Delivery Network/ API Reference/ API/ Analytics/ Querying Domain Name Statistics by Region and Carrier
Updated on 2026-08-12 GMT+08:00

Querying Domain Name Statistics by Region and Carrier

Function

This API is used to query the summary or detailed statistics of a domain name. You can query statistics by domain name, country/region, province, and carrier. You can query metrics such as the bandwidth, traffic, request count, and HTTP status codes of a domain name.

  • You can query data within the past 90 days.

  • You can query up to five metrics each time.

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

  • The start time and end time must be both specified in milliseconds. They form a left-closed, right-open range and must align exactly with the specified query interval. For example, if the query interval is 5 minutes, the start time and end time must be exact multiples of 5 minutes, such as 0, 5, 10, and 15 minutes past the hour. If the time points do not match the query interval, the query may return unexpected results. The start time is used to represent a time segment. For example, if the start time 2019-01-24 20:15:00 and the query interval is 5 minutes, the statistics within [20:15:00, 20:20:00) will be covered.

  • Traffic metrics are measured in bytes, bandwidth metrics in bit/s, and request and status code metrics in counts. You can query regional, carrier-specific statistics of specific metrics for specific domain names.

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

  • When action is set to location_detail and stat_type is set to req_num, you can calculate the QPS based on the returned value of the API. The formula is as follows: QPS = Number of requests within a single query interval/Query interval.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Definition

Type of data to be queried.

Constraints

N/A

Range

  • location_summary: summary data

  • location_detail: detailed data

Default Value

N/A

start_time

Yes

Long

Definition

Start timestamp of the query.

Constraints

Both the start time and end time must be specified. The start time is inclusive and the end time is exclusive during query.

Range

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

  • If interval is set to 3600 (1 hour), set start_time to the top of an hour, for example, 1631239200000 (2021-09-10 10:00:00).

  • If interval is set to 86400 (1 day), set start_time to 00:00:00 in GMT+08:00, for example, 1631203200000 (2021-09-10 00:00:00).

Default Value

N/A

end_time

Yes

Long

Definition

End timestamp of the query.

Constraints

Both the start time and end time must be specified. The start time is inclusive and the end time is exclusive during query.

Range

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

  • If interval is set to 3600 (1 hour), set end_time to the top of an hour, for example, 1631239200000 (2021-09-10 10:00:00).

  • If interval is set to 86400 (1 day), set end_time to 00:00:00 in GMT+08:00, for example, 1631203200000 (2021-09-10 00:00:00).

Default Value

N/A

domain_name

Yes

String

Definition

Domain name list.

NOTE:
If no data is available for a domain name within the query period, no information about the domain name is returned.

Constraints

You can query only domain names that have been added to CDN.

Range

  • all indicates that all domain names are queried.

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

Default Value

N/A

stat_type

Yes

String

Definition

  • Metric type.

  • Network resource consumption statistics:

    • bw: bandwidth

    • flux: traffic

  • Access statistics:

    • req_num: number of requests

  • HTTP status code statistics (composite metrics):

    • http_code_2xx: status codes 2xx

    • http_code_3xx: status codes 3xx

    • http_code_4xx: status codes 4xx

    • http_code_5xx: status codes 5xx

    • status_code_2xx: details of status codes 2xx

    • status_code_3xx: details of status codes 3xx

    • status_code_4xx: details of status codes 4xx

    • status_code_5xx: details of status codes 5xx

    Default Value

Constraints

N/A

Range

N/A

ip_version

No

String

Definition

Client transmission protocol.

Constraints

Only one protocol can be selected. IPv4 and IPv6 cannot be configured at the same time.

Range

  • IPv4

  • IPv6

  • If this parameter is not specified, all data is queried by default.

Default Value

N/A

interval

No

Long

Definition

Query interval.

Constraints

  • If the query time range is within one day, 5-minute and 1-hour intervals are supported.

  • If the query time range is within 7 days, 5-minute, 1-hour, and 1-day intervals are supported.

  • If the query time range is within 31 days, 1-hour, and 1-day intervals are supported.

Range

  • 300: 5-minute sampling interval, in seconds

  • 3600: 1-hour sampling interval, in seconds

  • 86400: 1-day sampling interval, in seconds

Default Value

By default, the minimum interval supported for the specified query time range is used.

NOTE:
The minimum interval is 300 if the query time range is not greater than 7 days, and 3600 if the range is greater than 7 days.

country

No

String

Definition

Country and region codes.

Constraints

  • Do not pass this parameter when carrier statistics are queried.

  • Do not pass this parameter when top URL (top_url) statistics are queried.

  • Set this parameter to cn (China) when regional statistics are queried.

Range

  • Separate multiple values with commas (,).

  • Use all to represent all options. For details, see the appendix.

Default Value

N/A

province

No

String

Definition

Province code.

Constraints

This parameter is valid only when country is set to cn (China).

Range

  • Separate multiple values with commas (,).

  • Use all to represent all options. For details, see the appendix.

Default Value

N/A

isp

No

String

Definition

Carrier code.

Constraints

N/A

Range

  • Separate multiple values with commas (,).

  • Use all to represent all options. For details, see the appendix.

Default Value

N/A

group_by

No

String

Definition

Data grouping method.

Constraints

N/A

Range

  • Separate multiple values with commas (,).

  • domain: by domain name

  • country: by country and region

  • province: by province

  • isp: by carrier

Default Value

Data is not grouped by default.

enterprise_project_id

No

String

Definition

Enterprise project ID.

NOTE:
You can obtain the enterprise project ID by calling the ListEnterpriseProject API of EPS.

Constraints

  • This parameter is valid only when the enterprise project function is enabled. It specifies the enterprise project to which the resource belongs.

  • This parameter is mandatory when you use an IAM user to call this API.

Range

all: all projects

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

group_by

String

Definition

Data grouping method.

Range

  • domain: by domain name

  • country: by country and region

  • province: by province

  • isp: by carrier

result

Map<String,Object>

Definition

Data organized using the specified grouping method

Range

N/A

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

Example Requests

  • Ungrouped domain details

    GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/domain-location-stats?action=location_summary&start_time=1667030400000&end_time=1667116800000&domain_name=www.test1.com&stat_type=flux&interval=300&country=cn&province=sichuan&isp=dianxin&enterprise_project_id=all
  • Domain details by domain

    GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/domain-location-stats?action=location_summary&start_time=1667030400000&end_time=1667116800000&domain_name=www.test1.com&stat_type=flux&interval=300&country=cn&province=sichuan&isp=dianxin&group_by=domain&enterprise_project_id=all

Example Responses

Status code: 200

Success response

  • Ungrouped domain details

    {
      "result" : {
        "flux" : [ 0, 1, 2 ]
      }
    }
  • Domain details by domain

    {
      "group_by" : "domain",
      "result" : {
        "www.test1.com" : {
          "flux" : [ 0, 1, 2 ]
        },
        "www.test2.com" : {
          "flux" : [ 0, 1, 2 ]
        }
      }
    }
  • Domain details by country/region

    {
      "group_by" : "country",
      "result" : {
        "cn" : {
          "flux" : [ 0, 1, 2 ]
        },
        "jp" : {
          "flux" : [ 0, 1, 2 ]
        }
      }
    }
  • Domain details by province

    {
      "group_by" : "province",
      "result" : {
        "sichuan" : {
          "flux" : [ 0, 1, 2 ]
        },
        "hubei" : {
          "flux" : [ 0, 1, 2 ]
        }
      }
    }
  • Domain details by carrier

    {
      "group_by" : "isp",
      "result" : {
        "dianxin" : {
          "flux" : [ 0, 1, 2 ]
        },
        "liantong" : {
          "flux" : [ 0, 1, 2 ]
        }
      }
    }
  • Domain details by domain and country/region

    {
      "group_by" : "domain,country",
      "result" : {
        "www.test1.com" : {
          "cn" : {
            "flux" : [ 0, 1, 2 ]
          },
          "gb" : {
            "flux" : [ 0, 1, 2 ]
          }
        },
        "www.test2.com" : {
          "cn" : {
            "flux" : [ 0, 1, 2 ]
          },
          "gb" : {
            "flux" : [ 0, 1, 2 ]
          }
        }
      }
    }
  • Domain details by domain and carrier

    {
      "group_by" : "domain,isp",
      "result" : {
        "www.test1.com" : {
          "dianxin" : {
            "req_num" : [ 0, 1, 2 ]
          }
        },
        "www.test2.com" : {
          "dianxin" : {
            "req_num" : [ 0, 1, 2 ]
          }
        }
      }
    }
  • Overall domain data

    {
      "result" : {
        "flux" : 1024
      }
    }
  • Overall data by domain

    {
      "group_by" : "domain",
      "result" : {
        "www.test1.com" : {
          "flux" : 1024
        },
        "www.test2.com" : {
          "flux" : 1024
        }
      }
    }
  • Overall domain data by country/region

    {
      "group_by" : "country",
      "result" : {
        "cn" : {
          "flux" : 1024
        },
        "jp" : {
          "flux" : 1024
        }
      }
    }

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cdn.v2.region.CdnRegion;
import com.huaweicloud.sdk.cdn.v2.*;
import com.huaweicloud.sdk.cdn.v2.model.*;


public class ShowDomainLocationStatsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        CdnClient client = CdnClient.newBuilder()
                .withCredential(auth)
                .withRegion(CdnRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowDomainLocationStatsRequest request = new ShowDomainLocationStatsRequest();
        try {
            ShowDomainLocationStatsResponse response = client.showDomainLocationStats(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcdn.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = CdnClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CdnRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowDomainLocationStatsRequest()
        response = client.show_domain_location_stats(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cdn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := cdn.CdnClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := cdn.NewCdnClient(hcClient)

    request := &model.ShowDomainLocationStatsRequest{}
	response, err := client.ShowDomainLocationStats(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Success response

default

Abnormal response

Error Codes

See Error Codes.