Help Center/ Content Delivery Network/ API Reference/ API/ Analytics/ Querying Domain Name Statistics

Updated on 2024-11-06 GMT+08:00

Online Debugging

CLI Examples

View PDF

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

Calling Method

For details, see Calling APIs.

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 the top of an hour, for example, 1631239200000 (2021-09-10 10:00:00). If the value of interval is 86400, set this parameter 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. 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 the top of an hour, for example, 1631325600000 (2021-09-11 10:00:00). If the value of interval is 86400, set this parameter to 00:00:00 (GTM+08:00), for example, 1631376000000 (2021-09-12 00: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. If no data is available for a domain name within the query period, no information about the domain name is returned.
stat_type	Yes	String	Network resource consumption statistics: bw (bandwidth) flux (traffic) bs_bw (pull bandwidth) bs_flux (pull traffic) Access statistics: req_num (number of requests) hit_num (number of hits) bs_num (number of pull requests) bs_fail_num (number of failed pull requests) hit_flux (traffic generated by requests that hit the caches) 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) bs_http_code_2xx (origin status codes 2xx) bs_http_code_3xx (origin status codes 3xx) bs_http_code_4xx (origin status codes 4xx) bs_http_code_5xx (origin 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) bs_status_code_2xx (details of origin status codes 2xx) bs_status_code_3xx (details of origin status code 3xx) bs_status_code_4xx (details of origin status codes 4xx) bs_status_code_5xx (details of origin status codes 5xx) status_code and bs_status_code cannot be queried at the same time.
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. 86400 (1 day): The maximum query time span is 31 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	No	String	Service region. The value can be mainland_china (default), outside_mainland_china, or global. This parameter is invalid for querying origin pull metrics.
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 message.

Example Requests

Ungrouped details

GET https://cdn.myhuaweicloud.com/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=mainland_china&enterprise_project_id=all

Domain details by domain

GET https://cdn.myhuaweicloud.com/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=mainland_china&enterprise_project_id=all

Example Responses

Status code: 200

Success response

Ungrouped details

{
  "result" : {
    "503" : [ 1000, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
    "504" : [ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1000 ]
  }
}

Domain details by domain

{
  "result" : {
    "www.test1.com" : {
      "200" : [ 118, 105, 113, 115, 114, 111, 106, 108, 118, 94, 97, 113 ],
      "206" : [ 115, 113, 125, 102, 132, 95, 133, 105, 117, 109, 128, 109 ]
    },
    "www.test2.com" : {
      "200" : [ 118, 105, 113, 115, 114, 111, 106, 108, 118, 94, 97, 113 ],
      "206" : [ 115, 113, 125, 102, 132, 95, 133, 105, 117, 109, 128, 109 ]
    }
  }
}

SDK Sample Code

The SDK sample code is as follows.

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

    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();
        ShowDomainStatsRequest request = new ShowDomainStatsRequest();
        try {
            ShowDomainStatsResponse response = client.showDomainStats(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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 = ShowDomainStatsRequest()
        response = client.show_domain_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)

          

        

      
     

      
       
         
         
           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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cdn.NewCdnClient(
        cdn.CdnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

          

        

      
     