查询截图数据_图片管理_媒资管理_服务端API

描述

查询指定媒体截图。

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

请求参数

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

返回参数

名称	类型	描述
RequestId	String	请求ID
MediaSnapshot	MediaSnapshot	媒体截图数据

API示例

请求示例

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

返回示例

JSON格式

 {
      "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
      "MediaSnapshot":{
        "Total": 100,
        "Regular": "http://image.com/snapshot/sample{SnapshotCount}.jpg",
        "CreationTime":"2017-12-20T12:23:45Z",
        "JobId": "ad90a501b1b94ba6afb72374ad005046",
        "Snapshots":{
            "Snapshot":[
                {
                  "Index": 1,
                  "Url":"http://image.com/snapshot/sample00001.jpg"
                }
              ]
         }
       }
 }

错误码

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

SDK示例

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