You need to enable JavaScript to run this app.
导航
获取回源数据的统计排名
最近更新时间:2024.06.13 20:08:14首次发布时间:2024.04.16 14:36:30

API 说明

基于火山引擎内容分发网络(CDN)向源站发送的请求(回源请求),该 API 按加速域名对一系列的指标数据进行汇总,并对这些汇总数据按从大到小排序。

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

数据稳定性:受网络波动影响,回源节点上统计的指标数据可能会发生变化。大多数情况下,指标数据会在 12 小时内逐步稳定下来。

说明

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

使用限制

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

请求说明

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

请求参数

Query

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

Body

参数名称
数据类型
是否必选
参数说明
示例
Item
String
表示一个分组条件,用于对 Metric 数据进行汇总。当前,该参数值只能是 domain,表示按 DomainMetric 数据进行汇总。
domain
Metric
String

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

  • traffic:表示源站向内容分发网络传输的数据量,单位是 bytes。
  • bandwidth:表示基于源站向内容分发网络传输的数据量而计算的带宽峰值,单位是 bps。
  • requests:表示回源请求的数量。
关于每个指标的详情以及统计方式,参见 指标的定义以及统计方式
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

返回参数

参数名称
数据类型
参数说明
示例
Item
String
表示请求参数 Item 所指定的分组条件。
domain
TopDataDetails
Object[]
表示该 API 返回的结果数据。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024031923314574F098A8E1F336074314",
        "Action": "DescribeOriginRanking",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "Item": "domain",
        "TopDataDetails": [
            {
                "Metric": "traffic",
                "ValueDetails": [
                    {
                        "ItemKey": "www.example.com",
                        "Ratio": 0.9614,
                        "Timestamp": 0,
                        "Value": 3003726848
                    },
                    {
                        "ItemKey": "img.example.com",
                        "Ratio": 0.0223,
                        "Timestamp": 0,
                        "Value": 69603224
                    },
                    {
                        "ItemKey": "www.test.com",
                        "Ratio": 0.0073,
                        "Timestamp": 0,
                        "Value": 22942093
                    }
                ]
            }
        ]
    }
}