更新时间:2024-11-06 GMT+08:00
分享

查询域名统计数据

功能介绍

  • 支持查询90天内的数据。

  • 支持多指标同时查询,不超过5个。

  • 最多同时指定20个域名。

  • 起始时间和结束时间需要同时指定,左闭右开,毫秒级时间戳,且时间点必须为与查询时间间隔参数匹配的整时刻点。比如查询时间间隔为5分钟时,起始时间和结束时间必须为5分钟整时刻点,如:0分、5分、10分、15分等,如果时间点与时间间隔不匹配,返回数据可能与预期不一致。统一用开始时间表示一个时间段,如:2019-01-24 20:15:00 表示取 [20:15:00, 20:20:00)的统计数据,且左闭右开。

  • action取值:detail,summary

  • 流量类指标单位统一为Byte(字节)、带宽类指标单位统一为bit/s(比特/秒)、请求数类和状态码类指标单位统一为次数。用于查询指定域名、指定统计指标的明细数据。

  • 单租户调用频率:15次/s。

调用方法

请参见如何调用API

URI

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

表1 Query参数

参数

是否必选

参数类型

描述

action

String

  • 动作名称,可选summary、detail。

  • summary:查询汇总数据

  • detail:查询数据详情。

start_time

Long

  • 查询起始时间戳,需与结束时间戳同时指定,左闭右开,设置方式如下:

  • interval为300时,start_time设置为整5分钟时刻点,如:1631240100000(对应2021-09-10 10:15:00)

  • interval为3600时,start_time设置为整小时时刻点,如:1631239200000(对应2021-09-10 10:00:00)

  • interval为86400时,start_time设置为东8区零点时刻点,如:1631203200000(对应2021-09-10 00:00:00)

end_time

Long

  • 查询结束时间戳,需与开始时间戳同时指定,左闭右开,设置方式如下:

  • interval为300时,end_time设置为整5分钟时刻点,如:1631243700000(对应2021-09-10 11:15:00)

  • interval为3600时,end_time设置为整小时时刻点,如:1631325600000(对应2021-09-11 10:00:00)

  • interval为86400时,end_time设置为东8区零点时刻点,如:1631376000000(对应2021-09-12 00:00:00)

domain_name

String

域名列表,多个域名以逗号(半角)分隔,如:www.test1.com,www.test2.com

all表示查询名下全部域名。如果域名在查询时间段内无数据,结果将不返回该域名的信息。

stat_type

String

  • 网络资源消耗:

    • bw(带宽)

    • flux(流量)

    • bs_bw(回源带宽)

    • bs_flux(回源流量)

  • 访问情况

    • req_num(请求总数)

    • hit_num(请求命中次数)

    • bs_num(回源总数)

    • bs_fail_num(回源失败数)

    • hit_flux(命中流量)

  • HTTP状态码(组合指标)

    • http_code_2xx(状态码汇总2xx)

    • http_code_3xx(状态码汇总3xx)

    • http_code_4xx(状态码汇总4xx)

    • http_code_5xx(状态码汇总5xx)

    • bs_http_code_2xx(回源状态码汇总2xx)

    • bs_http_code_3xx(回源状态码汇总3xx)

    • bs_http_code_4xx(回源状态码汇总4xx)

    • bs_http_code_5xx(回源状态码汇总5xx)

    • status_code_2xx(状态码详情2xx)

    • status_code_3xx(状态码详情3xx)

    • status_code_4xx(状态码详情4xx)

    • status_code_5xx(状态码详情5xx)

    • bs_status_code_2xx(回源状态码详情2xx)

    • bs_status_code_3xx(回源状态码详情3xx)

    • bs_status_code_4xx(回源状态码详情4xx)

    • bs_status_code_5xx(回源状态码详情5xx)

    • status_code和bs_status_code不能一起查询

interval

Long

  • 查询时间间隔,单位:秒,取值说明:

  • 300(5分钟):最大查询跨度2天

  • 3600(1小时):最大查询跨度7天

  • 86400(1天):最大查询跨度31天

  • 如果不传,默认取对应时间跨度的最小间隔。

group_by

String

数据分组方式,可选domain,默认不分组

service_area

String

服务区域:mainland_china(默认)、outside_mainland_china、global,当查询回源类指标时该参数无效。

enterprise_project_id

String

当用户开启企业项目功能时,该参数生效,表示查询资源所属项目,"all"表示所有项目。注意:当使用子账号调用接口时,该参数必传。

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

result

Map<String,Object>

按指定的分组方式组织的数据

状态码: default

表3 响应Body参数

参数

参数类型

描述

error

ErrMsg object

用于返回具体的错误码和错误消息

表4 ErrMsg

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

  • 不分组详情数据

    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
  • 按域名分组详情数据

    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

响应示例

状态码: 200

正常响应

  • 不分组详情数据

    {
      "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 ]
      }
    }
  • 根据域名分组详情数据

    {
      "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代码示例

SDK代码示例如下。

 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 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());
        }
    }
}
 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 = 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)
 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.ShowDomainStatsRequest{}
	response, err := client.ShowDomainStats(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

正常响应

default

异常响应

错误码

请参见错误码

相关文档