You need to enable JavaScript to run this app.
导航
获取 TOP 回源 URL
最近更新时间:2024.07.10 17:17:47首次发布时间:2024.01.31 10:43:31

说明

在新版数据统计接口中,该 API 没有更新,可继续使用。

API 说明

基于火山引擎内容分发网络(CDN)的向源站发送的回源请求,该 API 对一个域名统计热门的回源 URL。

要调用该 API,您需要指定一个指标和一个统计时间段。您最多能查询过去 92 天的数据。

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

数据时效性:热门的回源 URL 是基于按小时粒度统计的指标数据。因此,数据统计可能会有 2 小时左右的延时。例如,对于 09:00 至 10:00 这个时间段的热门的回源 URL,您可以在 11:00 左右获取到准确的结果。

使用限制

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

请求说明

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

请求参数

Query

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

Body

参数名称
数据类型
是否必选
参数说明
示例
Domain
String
指定一个域名进行数据统计。
www.example.com
EndTime
Long
指定一个结束时间。时间格式是 Unix 时间戳,精度是秒。
1641845373
Item
String

指定一个统计对象。该参数的可用值如下:

  • url:表示对回源请求 URL 进行统计。
url
Metric
String

指定一个统计指标。基于该指标的统计数据,对 Item 进行排序。您可以指定以下指标:

  • flux:表示回源请求所产生的流量。单位是 Byte。

  • pv:表示回源请求数。

  • status_2xx:表示在回源请求的响应状态码中,范围在 200-299 内的状态码数量。

  • status_3xx:表示范围在 300-399 内的状态码数量。

  • status_4xx:表示范围在 400-499 内的状态码数量。

  • status_5xx:表示范围在 500-599 内的状态码数量。

flux
StartTime
Long

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

您必须同时指定 StartTimeEndTime,或者都不指定。如果您不指定这两个参数,该页面展示最近 24 小时的数据。
1641844915

返回参数

参数名称
数据类型
参数说明
示例
Domain
String
表示指定的域名。
www.example.com
Item
String
表示指定的统计对象。该参数值是 url,表示对回源请求 URL 进行统计。
url
Metric
String
表示指定的排序指标。
flux
TopDataDetails
Object[]
表示排序后的对象列表以及每个对象的指标数据。

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeOriginTopStatisticalData&Version=2021-03-01
{
    "Domain":"www.example.com",
    "StartTime":1702742400,
    "EndTime":1702742400,
    "Item": "url",
    "Metric": "flux",
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20231218104008F1E2EB3BEFFEE70DFDE9",
        "Action": "DescribeOriginTopStatisticalData",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    },
    "Result": {
        "Item": "url",
        "Metric": "flux",
        "Domain": "www.example.com",
        "TopDataDetails": [
            {
                "ItemKey": "https://www.example.com/images/chickadee.png",
                "Value": 11098443381
            },
            {
                "ItemKey": "https://www.example.com/images/hornbill.png",
                "Value": 4545790702
            },
        ]
    }
}

错误码

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