Help Center/ Content Delivery Network/ API Reference/ API/ Analytics/ Querying Daily Client Access Details by Domain Name
Updated on 2026-08-17 GMT+08:00

Querying Daily Client Access Details by Domain Name

Function

This API is used to query daily client access details by domain name.

  • You can query data within the past 90 days.

  • The query time span is limited to 1 day for ip_num and 5 minutes for uv.

  • The start time and end time must be both specified. The time range is left-closed and right-open. For example, if the start time is 2022-07-12 00:00:00 and end time is 2022-07-13 00:00:00, the statistics in [2022-07-12 00:00:00, 2022-07-13 00:00:00) will be queried.

  • For the ip_num query, the start time and end time must be timestamps in milliseconds. They must be 00:00:00. Otherwise, the query may return unexpected data.

  • For the uv query, both timestamps must be exact multiples of 5 minutes, such as 0, 5, 10, and 15 minutes past the hour. If the values are not exact multiples of 5 minutes, the query may return unexpected data.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

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

Types of client access metrics.

Constraints

N/A

Range

  • ip_num: number of unique IP addresses

  • uv: number of unique visitors within 5 minutes. Each unique IP address is counted as a unique visitor.

Default Value

N/A

service_area

No

String

Definition

Service area.

Constraints

N/A

Range

  • mainland_china: Chinese mainland

  • outside_mainland_china: outside the Chinese mainland

  • mainland_china: Chinese mainland

Default Value

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

service_area

String

Definition

Service area.

Range

  • mainland_china: Chinese mainland

  • outside_mainland_china: outside the Chinese mainland

result

Array of Map<String,Object> objects

Definition

Daily client access details by domain name.

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

Querying client access details

GET https://cdn.myhuaweicloud.com/v1.0/cdn/statistics/domain-client-stats?start_time=1577808000000&end_time=1577894400000&domain_name=www.test1.com&stat_type=uv

Example Responses

Status code: 200

Success response.

{
  "service_area" : "mainland_china",
  "result" : [ {
    "domain_name" : "www.test1.com",
    "uv" : [ 100, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ]
  }, {
    "domain_name" : "www.test2.com",
    "uv" : [ 100, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ]
  }, {
    "domain_name" : "www.test3.com",
    "uv" : [ 100, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ]
  } ]
}

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 ListDomainClientStatsSolution {

    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();
        ListDomainClientStatsRequest request = new ListDomainClientStatsRequest();
        try {
            ListDomainClientStatsResponse response = client.listDomainClientStats(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 = ListDomainClientStatsRequest()
        response = client.list_domain_client_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.ListDomainClientStatsRequest{}
	response, err := client.ListDomainClientStats(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

Error response.

Error Codes

See Error Codes.