最近更新时间:2023.11.01 10:46:35
首次发布时间:2023.09.25 14:34:04
调用接口查询指定 Vhost
下的直播截图历史详情。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeCDNSnapshotHistory | 接口名称。当前 API 的名称为 DescribeCDNSnapshotHistory 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-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 | 查询时间范围的开始时间,RFC3339 格式的 UTC 时间,精度为 s。当您查询指定截图任务详情时,DateFrom 应设置为开始时间之前的任意时间。 |
DateTo | String | 是 | 2022-04-02T00:00:00+08:00 | 查询时间范围的结束时间,结束时间需晚于 DateFrom,且与 DateFrom 间隔不超过 7天,RFC3339 格式的 UTC 时间,精度为 s。 |
PageNum | Integer | 否 | 1 | 分页查询页码。 |
PageSize | Integer | 否 | 30 | 单个分页中,查询的结果数量。 |
Type | String | 否 |
| 截图文件保存位置。默认取值为 tos。
|
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
StreamInfoList | Array of StreamInfoList | - | 截图历史列表记录。 |
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=2023-01-01 { "Vhost": "push.example.com", "App": "live", "Stream": "stream-123" }
{ "ResponseMetadata":{ "RequestId":"201806041104200100100232280022D30", "Action":"DescribeCDNSnapshotHistory", "Version":"2023-01-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 } } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | CommonErr | - | 未分类错误。建议重试,如果仍返回该错误码,请联系技术支持。 |
400 | InvalidParam | - | 输入的参数无效或不符合要求,请参照请求参数说明进行检查。 |
400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验,请检查参数类型是否正确。 |
403 | RequestForbidden | - | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
403 | RequestForbidden.AccountIDNotAllow | this AccountID does not have permission to access the corresponding resource, please check the request parameters | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
403 | RequestForbidden.BillingStatus | Billing status is not available for the AccountID, please activate the service or recharge. | 未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。 |
404 | ResourceNotFound | - | 未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持。 |
500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误,请联系技术支持。 |
502 | InternalServiceError | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
502 | InternalServiceError.BadResponse | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
504 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时,请联系技术支持。 |