获取热点统计数据--视频点播-火山引擎

文档中心

立即注册

导航

获取热点统计数据

最近更新时间：2024.10.25 11:22:16首次发布时间：2023.07.28 17:07:19

调用此接口获取指定时间段内某个域名的热点数据和访问量。

使用说明

此接口对用户请求中的以下字段进行统计。

URL：按流量或请求数获取 TOP 1000 的请求 URL。
Referer：按流量或请求数获取 TOP 1000 的请求 Referer。

统计的最小时间粒度为 1 小时。系统会选择大于等于 StartTime 并且小于等于 EndTime 的时间范围，以小时为数据点，对字段进行统计排序。示例如下：

StartTime 为 2022-01-14 03:00:00 且 EndTime 为 2022-01-14 04:00:00：数据排序是基于 03:00:00 - 04:00:00 和 04:00:00 - 05:00:00 两个时间段的汇总统计数据。
StartTime 为 2022-01-14 03:20:00 且 EndTime 为 2022-01-14 04:20:00：数据排序是基于04:00:00 - 05:00:00 时间段的统计数据。
StartTime 为 2022-01-14 03:20:00 且 EndTime 为 2022-01-14 05:00:00：数据排序是基于 04:00:00 - 05:00:00 和 05:00:00 - 06:00:00 两个时间段的汇总统计数据。
StartTime 为 2022-01-14 03:00:00 且 EndTime 为 2022-01-14 04:20:00：数据排序是基于 03:00:00 - 04:00:00 和 04:00:00 - 05:00:00 两个时间段的汇总统计数据。

注意事项

数据稳定性：受边缘节点网络波动的影响，监控数据的统计可能会发生变化。大多数情况下，监控数据的统计会在数据产生后的 12 小时内稳定下来。
数据时延：热点数据的统计是基于以小时粒度统计的指标数据。因此，热点数据的统计可能会有 2 小时左右的延时。例如，对于 09:00 至 10:00 这个时间段内的热点数据统计，您可以在 11:00 左右获取到准确的结果。
您最多能查询过去 92 天的数据。

请求说明

请求地址：https://vod.volcengineapi.com?Action=ListCdnTopAccess&Version=2023-07-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数	类型	是否必选	示例值	描述
Action	String	是	`ListCdnTopAccess`	接口名称。当前 API 的名称为 `ListCdnTopAccess`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
Domains	String	是	`www.example.vod.com`	域名。您可通过 ListDomain 接口获取指定空间下的域名列表。注意当前仅支持一个域名。
StartTimestamp	Integer	否	`1689667200`	查询起始时间。Unix 时间戳，精度为秒。不传默认当天 00:00:00。
EndTimestamp	Integer	否	`1689824898`	查询结束时间，Unix 时间戳，精度为秒。不传默认当天 23:59:59。
SortType	String	否	`flux`	统计指标。基于该指标的统计数据，对 `Item` 进行排序。取值如下： `flux`：按流量。 `pv`：（默认）按请求数（访问量）。
Item	String	否	`url`	统计字段。取值如下： `url`：（默认）表示请求 URL。 `referer`：表示请求 Referer。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
ItemInfos	Object[]	`-`	热点统计数据列表信息。
Value	Double	`59`	根据统计字段和统计方式得到的对应值。
ItemKey	String	`www.example.vod.com`	根据 `Item` 所得对应的 key。取值如下：当`Item` 为 `url`时，该参数值为请求 URL。当`Item` 为 `referer` 时，该参数值为请求 Referer。

请求示例

https://vod.volcengineapi.com?Action=ListCdnTopAccess&Version=2023-07-01&Domains=test.domain.com&StartTimestamp=1718899200&EndTimestamp=1718985599&SortType=pv&Item=url

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104****100232280022D31",
    "Action": "ListCdnTopAccess",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "ItemInfos": [
      {
        "ItemKey": "www.example.vod.com",
        "Value": 59
      }
    ]
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码，请参考如下：