You need to enable JavaScript to run this app.
导航

获取访问统计的汇总数据_计费区域

最近更新时间2024.05.06 14:11:21

首次发布时间2024.04.16 14:36:30

API 说明

基于内容分发网络收到的用户请求,该 API 对一个指标统计其汇总数据。

要调用该 API,您需要指定一个指标,一个统计时间段和一个时间粒度。您还可以指定多个过滤条件(包括计费区域)对用户请求进行过滤。您最多能查询过去 92 天的数据。

数据稳定性:受网络波动影响,边缘节点上的指标数据可能会发生变化。大多数情况下,在内容分发网络记录原始数据后的 12 小时内,对应的指标数据会逐步稳定下来。

说明

如果您是刚开始使用数据统计的 API,请务必先阅读以下文档,这将有助于您理解该 API 文档。

使用限制

节流限制:您每秒最多可以提交 20 个 API 请求。

请求说明

  • 请求方式:POST
  • 请求地址:https://cdn.volcengineapi.com/?Action=DescribeEdgeSummary&Version=2021-03-01

请求参数

Query

参数名称
数据类型
是否必选
参数说明
Action
String
接口名称。当前 API 的名称为 DescribeEdgeSummary
Version
String
接口版本。当前 API 的版本为 2021-03-01

Body

参数名称
数据类型
是否必选
参数说明
示例
Metric
String

表示一个指标。该参数有以下取值:

  • traffic:表示内容分发网络响应用户请求所消耗的流量,单位是 Byte。
  • bandwidth:表示内容分发网络响应用户请求所消耗的带宽峰值,单位是 bps。
  • requests:表示内容分发网络收到的用户请求数量。
  • qps:表示内容分发网络收到的用户请求的 QPS 峰值。
  • traffic_hitrate:表示内容分发网络响应那些命中缓存的用户请求所消耗的流量占比,以数值形式显示。例如,0.9999 表示 99.99%。
  • response_time:表示内容分发网络响应用户请求所耗费的平均时间,单位是毫秒(ms)。
  • avg_speed:表示内容分发网络在响应用户请求时的平均数据传输速度,单位是 Byte/s。
  • status_all:对于内容分发网络对用户请求的响应,该参数表示以下各类别状态码的数量:
    • 所有状态码的数量。
    • 2xx 状态码的数量。
    • 3xx 状态码的数量。
    • 4xx 状态码的数量。
    • 5xx 状态码的数量。
    • 每个状态码的数量。
  • status_2xx:表示 2xx 状态码的数量以及以数字 2 开头的每个状态码的数量。
  • status_3xx:表示 3xx 状态码的数量以及以数字 3 开头的每个状态码的数量。
  • status_4xx:表示 4xx 状态码的数量以及以数字 4 开头的每个状态码的数量。
  • status_5xx:表示 5xx 状态码的数量以及以数字 5 开头的每个状态码的数量。
关于每个指标的详情以及统计方式,参见 指标的定义以及统计方式
traffic
StartTime
Long
表示统计时间段的开始时间,格式是 Unix 时间戳,精度是秒。StartTime 必须早于或者等于 EndTime。同时,StartTime 与 EndTime 所表示的统计时间段不能超过 31 天。
1710259200
EndTime
Long
表示统计时间段的结束时间,格式是 Unix 时间戳,精度是秒。
1710836303
Interval
String

表示一个时间粒度。该 API 基于 IntervalStartTimeEndTime 所表示的统计时间段拆分成一系列的时间区间,然后对每个时间区间统计 Metric 数据。

关于 Interval 参数是如何用来拆分统计时间段,参考 统计时间段说明

该参数有以下取值:

  • 1min:表示时间粒度是 1 分钟。
  • 5min:表示时间粒度是 5 分钟。

您可以指定的时间粒度受 StartTime 和 EndTime 所表示的时间范围的影响。

  • 如果时间范围 <= 1 天,您可以指定的时间粒度有 1min5min
  • 如果 1 天 < 时间范围 <= 31 天,您可以指定的时间粒度只能是 5min
该参数的默认值是 5min。如果默认值不匹配时间范围,API 请求会失败。
5min
Project
String

表示一个项目,以获取该项目下的所有加速域名,用于对用户请求进行过滤。

如果不指定 Project,表示不使用该参数对请求进行过滤。
my_project
Domain
String

表示一个或多个加速域名,用于对内容分发网络收到请求进行过滤。您最多可以指定 50 个加速域名。多个域名之间使用逗号(,)分隔。如果您不指定 Domain,表示不使用该参数对请求进行过滤。

如果您指定了 Project,您可以指定的加速域名必须是归属于该指定的项目。

说明

当子用户调用该 API 时,请留意以下说明:

  • 子用户只能指定其有权限访问的加速域名。子用户可以调用 ListCdnDomains 获取其有权限访问的加速域名。
  • 如果不指定该参数,表示所有该子用户有权限访问的那些加速域名。
www.example.com,www.test.com,img.example.com
BillingRegion
String

表示一个或多个计费区域,用于对用户请求进行过滤。该 API 对来自这些计费区域的用户请求统计 Metric 数据。多个计费区域之间使用逗号(,)分隔。该参数有以下取值:

  • CHN:表示中国内地。
  • EU:表示欧洲区。
  • NA:表示北美区。
  • SA:表示南美区。
  • MEA:表示中东区和非洲区。
  • AP1:表示亚太一区。
  • AP2:表示亚太二区。
  • AP3:表示亚太三区。
如果不指定 BillingRegion,表示不使用该参数对请求进行过滤。
CHN,EU

返回参数

参数名称
数据类型
参数说明
示例
MetricDataList
Object[]
表示该 API 返回的结果数据。

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeEdgeSummary&Version=2021-03-01
{
    "Domain": "www.example.com,www.test.com,img.example.com",
    "StartTime": 1710259200,
    "EndTime": 1710835599,
    "Interval": "5min",
    "Metric": "bandwidth",
    "Project": "my_project",
    "BillingRegion": "CHN,EU"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024031920490843CBB23C0BC82C021B5E",
        "Action": "DescribeEdgeSummary",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    },
    "Result": {
        "MetricDataList": [
            {
                "Metric": "bandwidth",
                "Value": 8312
            }
        ]
    }
}