调用ListSnapshots查询指定媒体截图。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListSnapshots

系统规定参数。取值: ListSnapshots

VideoId String d3e680e618708*****fbf2cae7cc931

视频ID。

SnapshotType String CoverSnapshot

返回的截图类型。取值范围:

  • CoverSnapshot(默认值):封面截图。
  • NormalSnapshot:普通截图。
  • SpriteSnapshot:雪碧截图。
  • SpriteOriginSnapshot:雪碧图原始图。
  • WebVttSnapshot:WebVtt截图。
AuthTimeout String 3600

截图地址过期时间。默认值:3600秒,最小值:3600秒

  • 当指定时间小于3600秒时,默认为3600秒
  • 如果返回的是OSS地址,为降低源站安全风险,最大值为2592000(即30天)。该参数只有开启了URL鉴权才会生效。
PageSize String 20

翻页大小,每页显示条数。默认值:20,最大值:100

PageNo String 1

翻页页号。默认值:1

返回数据

名称 类型 示例值 描述
MediaSnapshot Struct

媒体截图数据。

CreationTime String 2017-12-20T12:23:45Z

截图作业创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

JobId String ad90a501b1b94*****72374ad005046

截图作业ID。

Regular String http://image.com/snapshot/sample{SnapshotCount}.jpg

截图地址生成规则。

Snapshots Array of Snapshot

截图数据。

Snapshot
Index Long 1

截图索引值。

Url String http://image.com/snapshot/sample00001.jpg

截图地址。

Total Long 100

截图总数。

RequestId String 25818875-5F78-4A*****F6-D7393642CA58

请求ID。

示例

请求示例

https://vod.aliyuncs.com/?Action=ListSnapshots
&VideoId=d3e680e618708*****fbf2cae7cc931
&<公共请求参数>

正常返回示例

XML 格式

<ListSnapshotsResponse>
      <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
	  <MediaSnapshot>
		    <Total>100</Total>
		    <Regular>http://image.com/snapshot/sample{SnapshotCount}.jpg</Regular>
		    <CreationTime>2017-12-20T12:23:45Z</CreationTime>
		    <JobId>ad90a501b1b94*****72374ad005046</JobId>
		    <Snapshots>
			      <Snapshot>
				        <Index>1</Index>
				        <Url>http://image.com/snapshot/sample00001.jpg</Url>
			      </Snapshot>
		    </Snapshots>
	  </MediaSnapshot>
</ListSnapshotsResponse>

JSON 格式

{
    "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
    "MediaSnapshot":{
        "Total": 100,
        "Regular": "http://image.com/snapshot/sample{SnapshotCount}.jpg",
        "CreationTime":"2017-12-20T12:23:45Z",
        "JobId": "ad90a501b1b94*****72374ad005046",
        "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各语言调用的示例代码,请参考如下: