You need to enable JavaScript to run this app.
导航
获取请求数
最近更新时间:2024.06.25 12:54:27首次发布时间:2022.06.27 09:59:27

此接口用于设置域名、统计数据类别等参数,在一定时间范围内,获取指定的请求数数据。

注意事项

时间范围:查询的时间跨度不超过 90 天

请求说明

请求地址:https://vod.volcengineapi.com?Action=ListCdnPvData&Version=2022-01-01

调试

请求参数

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

参数
类型
是否必选
示例值
描述
Action
String
ListCdnPvData
接口名称。当前 API 的名称为 ListCdnPvData
Version
String
2022-01-01
接口版本。当前 API 的版本为 2022-01-01
Domains
String
example.vod.com
域名,多个用英文逗号 , 隔开。您可通过 ListDomain 接口获取指定空间下的域名列表。
Interval
String
auto

指定查询数据的时间粒度,单位:秒。取值如下:

  • auto:自动聚合。
  • 5min:5 分钟粒度。
  • hour:1 小时粒度。
  • day:天粒度。
StartTimestamp
Long
1703519999
查询范围起始时间。Unix 时间戳,单位为秒。它表示从 1970 年 1 月 1 日 00:00:00 UTC 到指定时间的秒数。默认当天 0 点。
EndTimestamp
Long
1703433600

查询范围截止时间。Unix 时间戳,单位为秒。它表示从 1970 年 1 月 1 日 00:00:00 UTC 到指定时间的秒数。默认为第二天 0 点。

说明

最大支持单次查询 90 天的数据。

DataType
String
edge

统计数据类别。取值如下:

  • edge:边缘数据统计。
  • origin:回源数据统计。
NeedDetail
Boolean
true

是否需要详细数据,分域名数据。 取值如下:

  • false:(默认)否。
  • true:是。

返回参数

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

参数
类型
示例值
描述
Datas
Object[]
-
用量信息。
Name
String
total
统计目标名。
Metric
String
pv
指标类别。取值为 pv
DataType
String
origin

统计类别。取值如下:

  • edge:边缘数据统计。
  • origin:回源数据统计。
Points
Object[]
-
打点数据。
Timestamp
Double
1653494400
时间戳。
Value
Double
458700098.3547

数值,单位为次。

说明

该参数可能不存在。

NoPermissionDomains
String[]
["example.vod.com"]
无权限域名列表。

请求示例

https://vod.volcengineapi.com?Action=ListCdnPvData&Version=2022-01-01&StartTimestamp=1718294400&EndTimestamp=1718985599&Interval=auto Domains=test1.demo.com,test2.demo.com&DataType=edge

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2022052615313***620412B5A92D",
    "Action": "ListCdnPvData",
    "Version": "2022-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "Datas": [
      {
        "Name": "total",
        "Metric": "pv",
        "DataType": "origin",
        "Points": [
          {
            "Timestamp": 1653494400,
            "Value": 458700098.3547
          }
        ]
      }
    ]
  }
}

错误码

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

服务端 SDK

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