You need to enable JavaScript to run this app.
导航
内容分发网络
  • 文档首页
    • /
  • 内容分发网络

获取回源数据的统计排名

最近更新时间：2024.04.16 14:45:14

首次发布时间：2022.03.23 11:21:52

我的收藏

说明

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

基于指定的时间段，对一个或多个域名统计回源请求指标的数据并排序。该 API 支持的指标排序依据如下：
数据稳定性：受边缘节点网络波动的影响，监控数据的统计可能会发生变化。大多数情况下，监控数据的统计会在数据产生后的 12 小时内稳定下来。

说明

带宽峰值的计算方法如下：

  • 以 Interval 参数指定的时间粒度统计一系列带宽数据，然后计算这些数据的最大值。

使用限制

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

时间限制：系统保留最近 92 天的访问数据。您不能查询 92 天以前的访问数据。

数据延迟：访问数据延迟约为 5 分钟 。

请求说明

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

请求参数

Query

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

Body

参数名称
数据类型
是否必选
参数说明
示例
StartTime
Long
是

指定一个开始时间。时间格式是 Unix 时间戳，精度是秒。StartTime 必须早于或者等于 EndTime。

您必须同时指定 StartTime 和 EndTime，或者都不指定。如果您不指定这 2 个参数，默认统计最近 24 小时的数据。
1641844915
EndTime
Long
是
指定一个结束时间。时间格式是 Unix 时间戳，精度是秒。
1641845373
Domain
String
否

指定一个或者多个加速域名，最多 50 个。基于 Metric 中指定的指标，对这些加速域名进行排序。

多个加速域名使用逗号（,）分隔。逗号后面不能加空格。

如果不指定该参数，则包含账号下的所有域名。

子账号调用说明：
如果是子账号调用该 API，需要注意以下几点：

  • 子账号指定了 Domain 参数。但是在指定的加速域名中存在该子账号无权限访问的域名。此时 API 调用会失败并且报您没有权限执行该操作错误。
  • 子账号未指定 Domain 参数。此时则包含该子账号有权限访问的所有域名。
关于更多子账号权限信息，参见 权限管理概述。
www.example.com
Item
String
是

指定一个排序维度。该参数的可用值是如下：

  • domain：统计各域名的指标数据并排序。
domain
Metric
String
是

指定一个指标作为排序依据。 排序是按照数据从大到小排列的。该参数的可用值如下：

  • flux：表示基于流量排序。
  • banthwidth：表示基于带宽峰值排序。
  • pv：表示基于请求数排序。
flux

响应正文

参数名称
数据类型
参数说明
示例
Item
String
表示统计的排序维度。
domain
Metric
String
表示统计的指标。包含所有指标。
flux
Name
String
表示指定统计的所有域名，未指定域名时为空，展示全部域名的回源数据，若域名无回源时，则不展示对应域名的数据
www.a.com,www.b.com
TopDataDetails
Object[]
表示一个或多个的统计数据对象。按指标数据从大到小排序。无域名回源数据时，用 null 表示
"TopDataDetails": null

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeOriginTopNrtData&Version=2021-03-01
{
    "StartTime": 1647774669,
    "EndTime": 1647963291,
    "Metric": "flux",
    "Domain":"www.example.com,www.example2.com",
    "Item":"domain"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220105181801010211175223230002B9",
        "Action": "DescribeOriginTopNrtData",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    },
    "Result": {
        "Item": "domain",
        "Metric": "Flux",
        "Name": "www.example.com,www.example2.com",
        "TopDataDetails": [
            {
                "Bandwidth": 33931.5093,
                "BandwidthPeakTime": 1647880500,
                "Flux": 1279818,
                "FluxRatio": 0.9480421257238183,
                "ItemKey": "www.example.com",
                "PV": 27,
                "PVRatio": 0.12735849056603774
            },
            {
                "Bandwidth": 62.3627,
                "BandwidthPeakTime": 1647800400,
                "Flux": 13904,
                "FluxRatio": 0.01029957206107741,
                "ItemKey": "www.example2.com",
                "PV": 31,
                "PVRatio": 0.14622641509433962
            },
        ]
    }
}

错误码

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