最近更新时间:2023.10.12 17:39:58
首次发布时间:2022.04.19 20:40:35
调用接口查询指定 Vhost
下的直播截图历史详情。
说明
该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询截图历史详情接口。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeCDNSnapshotHistory | 接口名称。当前 API 的名称为 DescribeCDNSnapshotHistory 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Vhost | String | 是 | push.example.com | 域名空间名称。由 1 到 60 位数字、字母、下划线及"-"和"."组成 |
App | String | 是 | live | 应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成 |
Stream | String | 是 | stream-123 | 流名称,由 1 到 100 位数字、字母、下划线及"-"和"."组成,如果指定 Stream ,必须同时指定 App 的值 |
DateFrom | String | 是 | 2022-04-01T00:00:00+08:00 | 查询时间范围的开始时间 |
DateTo | String | 是 | 2022-04-02T00:00:00+08:00 | 查询时间范围的结束时间 |
PageNum | Integer | 否 | 1 | 分页查询页码 |
PageSize | Integer | 否 | 30 | 单个分页中,查询的结果数量 |
Type | String | 否 |
| 截图文件保存位置。默认取值为 tos。
|
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Array of CDNSnapshotHistory | - | 截图历史列表记录 |
Pagination | Object of Pagination | - | 分页信息 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Vhost | String | push.example.com | 域名空间名称 |
App | String | live | 应用名称 |
Stream | String | stream-123 | 流名称 |
Path | String | 20210830135051697.jpeg | 截图文件保存的路径 |
FileSize | Float | 0 | 文件大小 |
TimeStamp | String | 2021-08-30 21:48:25.000 | 截图时间戳 |
Width | Integer | 720 | 视频宽度 |
Height | Integer | 1280 | 视频高度 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageCur | Integer | 1 | 当前页 |
PageSize | Integer | 20 | 当前页的大小 |
PageTotal | Integer | 231 | 当前页的数据量 |
TotalCount | Integer | 4613 | 数据总量 |
POST https://live.volcengineapi.com?Action=DescribeCDNSnapshotHistory&Version=2020-08-01 { "Vhost": "push.example.com", "App": "live", "Stream": "stream-123" }
{ "ResponseMetadata":{ "RequestId":"201806041104200100100232280022D30", "Action":"DescribeCDNSnapshotHistory", "Version":"2020-08-01", "Service":"live", "Region":"cn-north-1" } "Result":{ "Data":[ { "App": "live", "FileSize": 0, "Height": 1280, "Path": "20210830135051697.jpeg", "Stream": "testStream413", "TimeStamp": "2021-08-30 21:48:25.000", "Vhost": "example.org", "Width": 720 } ] "Pagination":{ "PageCur":1, "PageSize":20, "PageTotal":231, "TotalCount":4613 } } }
访问公共错误码获取详细信息。