全部产品
云市场

查询截图数据

更新时间:2019-06-27 19:49:07

描述

查询指定媒体截图。

注意:如有多次视频截图,则返回最近一次成功的截图数据。

请求参数

名称类型是否必需描述
ActionString系统规定参数。取值: ListSnapshots
VideoIdString视频ID
SnapshotTypeString返回的截图类型。默认值:CoverSnapshot。
取值范围:
  • CoverSnapshot(封面截图)
  • NormalSnapshot(SubmitSnapshotJob接口发起的普通截图)
  • SpriteSnapshot(SubmitSnapshotJob接口发起的雪碧截图)
  • SpriteOriginSnapshot(组成雪碧图的原始小图)
AuthTimeout String截图地址过期时间。
  • 默认值:3600秒
  • 最小值:3600秒 (当指定时间小于3600秒时,默认为3600秒)
  • 如果返回的是OSS地址,为降低源站安全风险,最大值为2592000(即30天)
  • 该参数只有开启了 URL鉴权 才会生效。
PageNo Long翻页页号。默认值:1
PageSize Long翻页大小。默认值:20,最大值:100

返回参数

名称类型描述
RequestIdString请求ID
MediaSnapshotMediaSnapshot媒体截图数据

API示例

请求示例

  1. https://vod.cn-shanghai.aliyuncs.com?Action=ListSnapshots&Video=d3e680e618708fef7cefbf2cae7cc931&SnapshotType=NormalSnapshot&pageNo=1&pageSize=20

返回示例

JSON格式

  1. {
  2. "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  3. "MediaSnapshot":{
  4. "Total": 100,
  5. "Regular": "http://image.com/snapshot/sample{SnapshotCount}.jpg",
  6. "CreationTime":"2017-12-20T12:23:45Z",
  7. "JobId": "ad90a501b1b94ba6afb72374ad005046",
  8. "Snapshots":{
  9. "Snapshot":[
  10. {
  11. "Index": 1,
  12. "Url":"http://image.com/snapshot/sample00001.jpg"
  13. }
  14. ]
  15. }
  16. }
  17. }

错误码

错误代码错误信息HTTP 状态码说明
InvalidVideo.NotFoundThe video does not exist.404视频不存在。
NoSuchResourceThe specified resource %s does not exist404指定资源不存在。
Forbidden.IllegalStatusStatus of the video is illegal.400视频状态无效。只有状态为 上传完成正常审核中 以及 屏蔽 的视频才能查询截图数据。

SDK示例

建议使用 服务端SDK 来调用API,此API各语言调用的示例代码,请参考如下: