You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/数据统计/分发统计/DescribeVodPathRequestData - 按目录维度获取监控数据
DescribeVodPathRequestData - 按目录维度获取监控数据
最近更新时间：2025.02.18 10:42:47首次发布时间：2025.02.18 10:42:47
我的收藏

调用 DescribeVodPathRequestData 接口按目录维度获取监控数据，包括流量和访问次数。

使用说明

  • 该接口仅支持白名单用户调用。使用前请提交工单联系火山引擎技术支持团队申请开通。

注意事项

  • 本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

请求说明

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

调试

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

请求参数

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

参数
类型
是否必选
示例值
描述
Action
String
是
DescribeVodPathRequestData
接口名称。当前 API 的名称为 DescribeVodPathRequestData。
Version
String
是
2023-07-01
接口版本。当前 API 的版本为 2023-07-01。
Domain
String
是
example.volcengine.com
加速域名。
Path
String
否
/
路径，以正斜线（/）开头，不填表示查询所有一级目录。如果路径是目录，需要以正斜线（/）结尾。
StartTime
String
是
2024-12-11T16:00:00.000Z
查询的起始时间。格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-DDThh:mm:ssZ。查询起始时间不能早于当前时间前的 186 天。
EndTime
String
是
2024-12-12T15:59:59.999Z
查询的结束时间。格式按照 ISO8601 表示法，并使用 UTC 时间，格式为yyyy-MM-DDThh:mm:ssZ。查询起始和结束时间间隔不能超过 24 小时。
Aggregation
Integer
否
300
聚合粒度，单位为秒。仅支持 300（5 分钟），默认为 300。
Region
String
是
cn-north-1

服务地域。取值如下：

  • cn-north-1：华北
  • ap-southeast-1：亚太东南（柔佛）
PageSize
Integer
否
100
分页查询的页大小。默认为 100，最大为 1000。
PageNum
Integer
否
1
分页查询的页号。从 1 开始，默认为 1。

返回参数

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

参数
类型
示例值
描述
Region
String
cn-north-1

服务地域。取值如下：

  • cn-north-1：华北
  • ap-southeast-1：亚太东南（柔佛）
Domain
String
example.volcengine.com
加速域名。
Path
String
/
路径。
StartTime
String
2024-12-11T16:00:00.000Z
查询起始时间。
EndTime
String
2024-12-12T15:59:59.999Z
查询结束时间。
Aggregation
Integer
300
聚合粒度，单位为秒。仅支持 300（5 分钟）。
PageSize
Integer
100
分页查询的页大小。
PageNum
Integer
1
分页查询的页号。
Total
Integer
288
总数据条数。
PathDetailData
Object[]
-
详细用量。
Path
String
/
路径。
Time
String
2024-12-11T16:00:00Z
时间点。格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-DDThh:mm:ssZ。
Acc
Integer
0
请求次数。
Traffic
Integer
0
流量，单位为 Byte。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodPathRequestData&Version=2023-07-01&Domain=example.volcengine.com&StartTime=2024-12-11T16:00:00.000Z&EndTime=2024-12-12T15:59:59.999Z&Region=cn-north-1

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420****100232280022D31",
    "Action": "DescribeVodPathRequestData",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "Region": "cn-north-1",
    "Domain": "example.volcengine.com",
    "Path": "/",
    "StartTime": "2024-12-11T16:00:00.000Z",
    "EndTime": "2024-12-12T15:59:59.999Z",
    "Aggregation": 300,
    "PageSize": 100,
    "PageNum": 1,
    "Total": 288,
    "PathDetailData": [
      {
        "Path": "/",
        "Time": "2024-12-11T16:00:00Z",
        "Acc": 0,
        "Traffic": 0
      }
    ]
  }
}

错误码

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