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

文档中心

立即注册

导航

获取热点统计数据

最近更新时间：2024.06.25 12:54:28首次发布时间：2023.07.28 17:07:19

点播支持查询 CDN 域名，在某个指定时间区域的热门数据排行。此接口用于设置域名、统计方式等参数，在一定时间范围内，获取指定的热点数据统计。

注意事项

目前仅支持查询一个域名的热点统计数据。

请求说明

请求地址：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`	开始时间，相对于 UTC 1970-01-01 到当前时间相隔的秒数。不传默认当天 00:00:00。
EndTimestamp	Integer	否	`1689824898`	结束时间，相对于 UTC 1970-01-01 到当前时间相隔的秒数，不传默认当天 23:59:59。
SortType	String	否	`flux`	统计方式。取值如下： `flux`：按流量。 `pv`：（默认）按请求数（访问量）。
Item	String	否	`url`	指定一个统计字段。取值如下： `url`：（默认）表示请求 URL。 `referer`：表示请求 Referer。

返回参数

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

参数	类型	示例值	描述
ItemInfos	Object[]	`-`	热点统计数据列表信息。
Value	Double	`59`	根据统计字段和统计方式得到的对应值。
ItemKey	String	`www.example.vod.com`	根据 Item 所得对应的 key。说明当请求参数 `Item` 取值为 `url` 时，该 `Itemkey` 参数返回值为每个有流量的 Url 路径。

请求示例

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 各语言调用的示例代码，请参考如下：