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

Querying Domain Name Statistics by Region and Carrier

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 location_detail and location_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, regions, and carriers.

  • 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-location-stats

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

action

Yes

String

  • Action name. Possible values: location_summary and location_detail.

  • location_summary: querying summary data.

  • location_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)

  • Access statistics:

    • req_num (number of requests)

  • 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)

    • 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)

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.

country

No

String

  • Country and region codes, which are separated by commas (,). The value all indicates all codes. For details about the values, see the appendix.

  • This parameter cannot be set when carrier statistics are queried.

  • This parameter cannot be set when top URL statistics are queried.

  • When accessing regional data, set this parameter to cn (China).

province

No

String

Province code. This parameter is valid when country is set to cn (China). Use commas (,) to separate multiple codes. all indicates all provinces are queried. For details about the values, see the appendix.

isp

No

String

Carrier code. Use commas (,) to separate multiple codes. all indicates all carriers are queried. For details about the values, see the appendix.

group_by

No

String

Data grouping mode. Use commas (,) to separate multiple groups. Available data groups are domain, country, province, and isp. By default, data is not grouped.

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

group_by

String

Data grouping mode.

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