获取回源统计的汇总数据--内容分发网络-火山引擎

文档中心

导航

获取回源统计的汇总数据

最近更新时间：2024.04.16 14:45:14首次发布时间：2022.01.17 14:32:01

说明

我们全新设计了数据统计 API。推荐您使用新版 API。

对一个或多个域名统计指定时间段的回源请求指标的数据。

数据稳定性：受边缘节点网络波动的影响，监控数据的统计可能会发生变化。大多数情况下，监控数据的统计会在数据产生后的 12 小时内稳定下来。

指标名称	指标描述
流量	表示源站响应回源请求所传输的总流量。该 API 对指定时间段的总流量进行统计。
带宽	表示源站响应回源请求所产生的带宽，单位是 bps。指定时间段的带宽的统计步骤如下：确定统计时间段。参见 DescribeCdnData 文档中的统计时间段说明。基于指定的时间粒度，对每个统计时间段统计带宽。带宽按以下公式计算： `流量` * 8 / `统计时间段的时间`。`时间`的单位是秒。计算这些统计时间段带宽的最大值。关于统计方式的示例，参见 DescribeEdgeNrtDataSummary 文档中的统计示例。
请求数	表示回源请求的数量。该 API 对指定时间段的回源请求总数进行统计。
QPS	表示回源请求的 QPS。指定时间段的 QPS 的统计步骤如下：确定统计时间段。参见 DescribeCdnData 文档中的统计时间段说明。基于指定的时间粒度，对每个统计时间段统计 QPS。QPS 按以下公式计算： `请求数` / `统计时间段的时间`。`时间`的单位是秒。计算这些统计时间段 QPS 的最大值。关于统计方式的示例，参见 DescribeEdgeNrtDataSummary 文档中的统计示例。
状态码	表示源站响应回源请求的状态码数量。该 API 对指定时间段的状态码总数进行统计。

使用限制

节流限制：您每秒最多可以发送 20 个 API 请求。

数据保留期限：系统保留最近 92 天的回源数据。您不能查询 92 天以前的回源数据。

数据时效性：回源数据延迟约为 5 分钟。

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
StartTime	Long	是	指定一个开始时间。时间格式是 Unix 时间戳，精度是秒。`StartTime` 必须早于或者等于 `EndTime`。您必须同时指定 `StartTime` 和 `EndTime`，或者都不指定。如果您不指定这 2 个参数，默认统计最近 24 小时的数据。 `StartTime`、`EndTime`、`Interval` 这三个参数决定了该 API 基于哪些时间段的数据做聚合。参见 DescribeCdnData 文档中的统计时间段说明。	`1641844915`
EndTime	Long	是	指定一个结束时间。时间格式是 Unix 时间戳，精度是秒。	`1641845373`
Metric	String	是	指定一个指标。该参数的可用值如下： `flux`：表示回源数据的总流量，单位是 Byte。 `bandwidth`：表示回源数据的带宽峰值，单位是bps。 `qps`：表示回源请求的 QPS 峰值。单位是个/秒。 `pv`：表示回源的总请求数。单位是个。 `status_all`：表示回源响应状态码的数量以及各状态码组中状态码的数量。每个状态码组包含同一数字开头的状态码。 `status_2xx`：表示数字 2 开头的每个状态码的数量。 `status_3xx`：表示数字 3 开头的每个状态码的数量。 `status_4xx`：表示数字 4 开头的每个状态码的数量。 `status_5xx`：表示数字 5 开头的每个状态码的数量。	`flux`
Domain	String	否	指定一个或多个加速域名。最多可指定 50 个加速域名。多域名场景下可使用 `Aggregate` 参数进行聚合统计或分域名统计。多个加速域名使用逗号`（,）`分隔。逗号后面不能加空格。如果不指定该参数，则包含账号下的所有域名。子账号调用说明：如果是子账号调用该 API，需要注意以下几点：子账号指定了 Domain 参数。但是在指定的加速域名中存在该子账号无权限访问的域名。此时 API 调用会失败并且报`您没有权限执行该操作`错误。子账号未指定 Domain 参数。此时则包含该子账号有权限访问的所有域名。关于更多子账号权限信息，参考权限管理概述。	`www.example.com`
Interval	String	否	指定一个时间粒度。基于这个粒度，对回源数据进行汇总统计。 `StartTime`、`EndTime`、`Interval` 这三个参数决定了该 API 基于哪些时间段的数据做聚合。参见 DescribeCdnData 文档中的统计时间段说明。该参数的可用值如下： `1min`：表示以 1 分钟为时间粒度。 `5min`：表示以 5 分钟为时间粒度。您可以指定的时间粒度与`StartTime` 和 `EndTime` 指定的时间范围的关系如下：如果时间范围 <= 1 天，您可以指定的时间粒度有 `1min`、`5min`。如果时间范围 <= 92 天，您可以指定的时间粒度是 `5min`。该参数使用默认值是 `5min`。	`1min`
Aggregate	String	否	指定是否汇总所有加速域名的指标。该参数适用于指定多个多加速域名进行统计的场景。该参数的可用值如下： `aggregate`：汇总所有加速域名的指标。 `disaggregate`：不汇总加速域名的指标。如果不指定 `Domain` 参数，表示对账号下所有加速域名进行汇总统计。此时系统强制设置 `Aggregate` 参数值为 `aggregate`。API 返回账号下所有域名的汇总指标。如果指定 `Domain` 参数。此时：如果不指定 `Aggregate` 参数，`Aggregate` 参数的默认值是 `disaggregate`。如果设置 `Aggregate` 参数值为 `disaggregate`，API 仅返回每个指定域名的汇总指标。如果设置 `Aggregate` 参数值为 `aggregate`，API 仅返回所有指定域名的汇总指标。	`disaggregate`

响应正文

参数名称	数据类型	参数说明	示例
Resources	Object[]	域名数据详情

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeOriginNrtDataSummary&Version=2021-03-01
{
    "StartTime": 1636559700,
    "EndTime": 1636560300,
    "Metric": "clientIp",
    "Domain": "www.example.com",
    "Interval": "day"
}

返回示例

{
        "ResponseMetadata": {
                "RequestId": "2021111810395401022524314707A38C00",
                "Action": "DescribeEdgeStatisticalData",
                "Version": "2021-03-01",
                "Service": "CDN",
                "Region": "cn-north-1"
        },
        "Result": {
                "Resources": [
                {
                        "Metrics": [
                        {
                                "Metric": "ClientIP",
                                "Values": [
                                {
                                        "TimeStamp": 1636473600,
                                        "Value": 284272   //域名无数据时Value值将会做补0处理
                                },
                                {
                                        "TimeStamp": 1636560000,
                                        "Value": 281153
                                }
                                ]
                        }
                        ],
                        "Name": "www.example.com"
                }
                ]
        }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。