查询播放统计文件下载地址--视频点播-火山引擎

文档中心

立即注册

导航

查询播放统计文件下载地址

最近更新时间：2024.11.06 16:27:39首次发布时间：2024.11.06 10:46:20

调用此接口查询指定空间下一定时间范围内播放统计文件的下载地址。

使用说明

支持查询近一年的播放统计文件下载地址。查询起始日期和结束日期的跨度不超过 93 天。
视频点播每天对前一天的 CDN 请求日志进行分析处理，生成播放统计文件。播放统计数据是 Vid 粒度的，播放统计文件是空间粒度的。播放统计文件内容包含媒体文件的播放次数、播放流量等统计信息。
播放次数统计说明：
- HLS 文件：访问 M3U8 文件时统计播放次数；访问 TS 文件不统计播放次数。
- 其它文件（如 MP4 文件）：播放请求带有 range 参数且 range 的 start 参数不等于 0 时不统计播放次数，其它情况统计播放次数。

注意事项

计费说明：详见按流量计费。
数据延迟：1 天。当前 11 点生成前一天的播放统计文件。
时间范围：查询的时间跨度不超过 93 天。
权限说明：当使用子账号请求接口时，接口会按照子账号进行权限校验，只返回该子账号有权限的数据。详见创建子账号并授权。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeVodVidTrafficFileLog`	接口名称。当前 API 的名称为 `DescribeVodVidTrafficFileLog`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SpaceList	String	否	`test`	空间名称。不传默认获取所有空间的信息。您可调用 ListSpace 接口获取当前账号下所有空间的名称。
StartTime	String	是	`2024-10-01T16:00:00Z`	查询的起始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
EndTime	String	是	`2024-11-01T16:00:00Z`	查询的结束时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。说明单次查询的时间跨度不可超过 93 天。

返回参数

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

参数	类型	示例值	描述
StartTime	String	`2024-10-01T16:00:00Z`	查询的起始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
EndTime	String	`2024-11-01T16:00:00Z`	查询的结束时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。说明单次查询的时间跨度不可超过 93 天。
SpaceList	String[]	`["test"]`	空间名称列表。
FileList	Object[]	`-`	播放统计文件列表。单次最大返回 10000 个文件。
Date	String	`2024-11-10`	播放统计数据的日期。格式为 yyyy-MM-dd。该日期的零点时刻包含在请求参数的查询时间区间内。例如请求参数中查询起始时间是 `20241101T12:34:00`，结束时间是 `20241102T08:12:00`，则该接口返回 `2024-11-02` 这一条数据。
Space	String	`test`	空间名称。
DownloadUrl	String	`example.gz`	播放统计文件的下载地址。30 分钟内有效。播放统计文件为 GZIP 压缩的 CSV 文件。播放统计文件内容包含： `date`：播放日期。 `vid`：视频 ID。 `flux`：播放流量，单位为字节。 `play_times`：总播放次数。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodVidTrafficFileLog&Version=2023-07-01&SpaceList=test&StartTime=2024-10-01T16:00:00Z&EndTime=2024-11-01T16:00:00Z

返回示例

{
    "Result": {
        "EndTime": "2024-11-01T16:00:00Z",
        "FileList": [
            {
                "Date": "2024-11-10",
                "Space": "test",
                "DownloadUrl": "example.gz"
            }
        ],
        "SpaceList": [
            "test"
        ],
        "StartTime": "2024-10-01T16:00:00Z"
    },
    "ResponseMetadata": {
        "Action": "DescribeVodVidTrafficFileLog",
        "Region": "cn-north-1",
        "Service": "vod",
        "Version": "2023-07-01",
        "RequestId": "20230604110420****100232280022D31"
    }
}

错误码

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