You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /
  • 视频点播

查询视频播放信息

最近更新时间：2024.01.08 11:26:25

首次发布时间：2022.09.27 21:09:36

我的收藏

此接口用于查询指定视频的播放信息。

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 数据延迟：正常情况下，数据延迟为 8 小时左右。

请求说明

请求地址：https://vod.volcengineapi.com?Action=DescribeVodPlayedStatisData&Version=2020-08-01

调试

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

请求参数

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

参数类型是否必选示例值描述
ActionString是DescribeVodPlayedStatisData接口名称。当前 API 的名称为 DescribeVodPlayedStatisData。
VersionString是2020-08-01接口版本。当前 API 的版本为 2020-08-01。

Space

String

是

test

点播空间名称。您可通过以下方式获取空间名称：

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。
StartTimeString是2023-12-23T16:00:00Z开始时间，RFC3339 格式。

EndTime

String

是

2023-12-24T15:59:59Z

结束时间，RFC3339 格式。

说明

最早查询 31 天内的数据。

VidList

Array of String

是

["v03c24g100***v0vp0ml6d3g", "v02c24g1000***v0ss463b0vg",v02c24g1***tkhs1v0tk8qog730]

查询的 Vid 列表，最大 100。

说明

如果 GET 请求，用英文逗号 , 连接。

OrderType

String

否

count_up

排序类型。取值如下：

  • count_up：按照次数升序。
  • count_down：（默认）按照次数降序。
  • traffic_up：按照流量升序。
  • traffic_down：按照流量降序。

返回参数

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

参数类型示例值描述
SpaceStringtest点播空间名称。
StartTimeString2023-12-23T16:00:00Z开始时间，RFC3339 格式。
EndTimeString2023-12-24T15:59:59Z结束时间，RFC3339 格式。
VidListArray of String["v03c24g10001c***v0vp0ml6d3","v02c24g10001***9s1v0ss463b","v02c24g10001***v0tk8qog730"]要查询的 vid 列表。

OrderType

String

count_up

排序类型。取值如下：

  • count_up：按照次数升序。
  • count_down：按照次数降序。
  • traffic_up：按照流量升序。
  • traffic_down：按照流量降序。
PlayStatInfosArray of PlayStatInfos-播放信息。

PlayStatInfos

参数类型示例值描述
VidStringv02c24g10001***v0tk8qog730视频 ID。
NameStringtitle视频名称。
SizeInteger121809370视频大小，单位为字节。
DurationFloat158.583视频长度，单位为秒。
CreateTimeString2023-12-25 14:19:20视频创建时间。
PlayCountInteger0播放次数。
TrafficInteger0流量，单位为字节。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodPlayedStatisData&Version=2020-08-01&Space=&StartTime=&EndTime=&VidList=&OrderType=

{
  "Space": "test",
  "StartTime": "2021-04-13T00:00:00Z",
  "EndTime": "2021-04-14T00:00:00Z",
  "VidList": [
    "1232131",
    "1324324"
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202312251425***B0AAD021485A65C0",
        "Action": "DescribeVodPlayedStatisData",
        "Version": "2023-07-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Space": "test",
        "StartTime": "2023-12-23T16:00:00Z",
        "EndTime": "2023-12-24T15:59:59Z",
        "VidList": [
            "v03c24g10001c***v0vp0ml6d3",
            "v02c24g10001***9s1v0ss463b",
            "v02c24g10001***v0tk8qog730"
        ],
        "OrderType": "count_up",
        "PlayStatInfos": [
            {
                "Vid": "v03c24g10001c***v0vp0ml6d3",
                "Name": "title",
                "Duration": 158.583,
                "Size": 121809370,
                "PlayCount": 0,
                "CreateTime": "2023-12-25 14:20:01",
                "Traffic": 0
            },
            {
                "Vid": "v02c24g10001***9s1v0ss463b",
                "Name": "title",
                "Duration": 158.583,
                "Size": 121809370,
                "PlayCount": 0,
                "CreateTime": "2023-12-25 14:19:40",
                "Traffic": 0
            },
            {
                "Vid": "v02c24g10001***v0tk8qog730",
                "Name": "title",
                "Duration": 158.583,
                "Size": 121809370,
                "PlayCount": 0,
                "CreateTime": "2023-12-25 14:19:20",
                "Traffic": 0
            }
        ]
    }
}

错误码

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