You need to enable JavaScript to run this app.
导航

查询播放 TopN 的视频

最近更新时间2024.01.08 17:26:45

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

此接口用于查询时间范围内播放 TopN 的视频信息。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

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

调试

请求参数

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

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

Space

String

test

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

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。
StartTimeString2023-12-23T16:00:00Z开始时间。日期格式要求符合 RFC3339 规范

EndTime

String

2023-12-24T15:59:59Z

结束时间。日期格式要求符合 RFC3339 规范。

说明

最早查询 31 天内的数据。

OrderType

String

traffic

排序类型。取值如下:

  • count:(默认)按照次数排序。
  • traffic:按照流量降序。
TopNInteger100返回视频的个数。默认值为 100。最大为 100。

返回参数

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

参数类型示例值描述
SpaceStringtest点播空间名称。
StartTimeString2023-12-23T16:00:00Z开始时间,RFC3339 格式。
EndTimeString2023-12-24T15:59:59Z结束时间,RFC3339 格式。

OrderType

String

traffic

排序类型。取值如下:

  • count:按照次数排序。
  • traffic:按照流量降序。
TopNInteger100返回视频的个数。
PlayStatInfosArray of PlayStatInfos-播放信息。

PlayStatInfos

参数类型示例值描述
VidStringv02c24g10001***k792ucabrgag视频 ID。
NameString水印.dash.mp4视频名称。
SizeInteger11135289视频大小,单位为字节。
DurationFloat107.867视频长度,单位为秒。
CreateTimeString2022-10-31 16:33:22视频创建时间。
PlayCountInteger2播放次数。
TrafficInteger1133流量,单位为字节。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodMostPlayedStatisData&Version=2020-08-01&Space=test&StartTime=2023-12-23T16:00:00Z&EndTime=2023-12-24T15:59:59Z&OrderType=traffic&TopN=100

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202312251433***64896865F42EFE9",
        "Action": "DescribeVodMostPlayedStatisData",
        "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",
        "OrderType": "traffic",
        "PlayStatInfos": [
            {
                "Vid": "v02c24g10001cald1cbh1vq4cc06mb40",
                "Name": "od(原画转封装),240,360,480,540,720,1080视频流",
                "Duration": 120.2,
                "Size": 32202259,
                "PlayCount": 736,
                "CreateTime": "2022-06-16 14:42:12",
                "Traffic": 212638450
            },
            {
                "Vid": "v02c24g1000***q4cc06mu9g",
                "Name": "加密,非加密od,240,360,480,540,720,1080视频流",
                "Duration": 120.2,
                "Size": 32202259,
                "PlayCount": 288,
                "CreateTime": "2022-06-16 19:54:15",
                "Traffic": 82958589
            },
            {
                "Vid": "v02c24g1000***kiv7mrolf0",
                "Name": "heihei",
                "Duration": 120.2,
                "Size": 32202259,
                "PlayCount": 2,
                "CreateTime": "2022-08-08 17:29:42",
                "Traffic": 32203993.999999996
            },
            {
                "Vid": "v02c24g10001***co9qbmp4en9g",
                "Name": "原片",
                "Duration": 120.2,
                "Size": 32202259,
                "PlayCount": 32,
                "CreateTime": "2022-06-16 20:06:16",
                "Traffic": 22175704
            },
            {
                "Vid": "v02c24g10001***k792ucabrgag",
                "Name": "水印.dash.mp4",
                "Duration": 107.867,
                "Size": 11135289,
                "PlayCount": 2,
                "CreateTime": "2022-10-31 16:33:22",
                "Traffic": 1133
            }
        ]
    }
}

错误码

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