调用ListSnapshots查询截图数据_视频点播(VOD)-阿里云帮助中心

调用本接口可以查询通过视频截图作业生成的截图，以及视频上传时系统生成的封面截图。

接口说明

若一个视频发起过多次视频截图，则本接口仅返回最近一次成功的截图数据。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值

名称	类型	必填	描述	示例值
VideoId	string	是	视频 ID。可通过以下方式获取：可登录点播控制台，选择媒资库 > 音/视频查看视频 ID。调用 CreateUploadVideo 接口获取上传地址和凭证时会返回。调用 SearchMedia 接口查询视频时会返回。	d3e680e618708fbf2cae7cc931****
SnapshotType	string	否	返回的截图类型。取值： CoverSnapshot（默认值）：封面截图。 NormalSnapshot：普通截图。 SpriteSnapshot：雪碧截图。 SpriteOriginSnapshot：雪碧图原始图。 WebVttSnapshot：WebVtt 截图。	CoverSnapshot
AuthTimeout	string	否	截图访问地址的过期时间。默认值：3600，最小值：3600，单位：秒。该参数只有开启了 URL 鉴权才会生效。当设置的时间小于 3600 秒时，默认为3600 秒。如果返回的是 OSS 地址，为降低源站安全风险，最大值为 2592000（即 30 天）。	3600
PageSize	string	否	翻页大小，每页显示条数。默认值：20，最大值：100。	20
PageNo	string	否	翻页页号。默认值：1。	1

返回参数

名称	类型	描述	示例值

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	25818875-5F78-4AF6-D7393642CA58****
MediaSnapshot	object	视频截图数据。
CreationTime	string	截图作业创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2017-12-20T12:23:45Z
Regular	string	截图地址生成规则。	http://example.aliyundoc.com/snapshot/sample{SnapshotCount}.jpg
Total	long	截图总数。	100
JobId	string	截图作业 ID。	ad90a501b1b9472374ad005046****
Snapshots	array<object>	截图详情。
Snapshot	object
Index	long	截图索引值。	1
Url	string	截图访问地址。	http://example.aliyundoc.com/snapshot/sample00001****.jpg

示例

正常返回示例

JSON格式

        

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

变更时间	变更内容概要	操作

暂无变更历史

接口错误码

下表列举了本接口特有的错误码。

错误代码	错误信息	HTTP 状态码	说明

错误代码	错误信息	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	视频状态无效。只有状态为上传完成、正常、审核中以及屏蔽的视频才能查询截图数据。