ListSnapshots - API Reference| Alibaba Cloud Documentation Center

Description

You can call this operation to query the snapshot data of a specified media.

Note: If a video has been snapshot multiple times, the data of the latest successful snapshot is returned.

Request parameters

Name	Type	Required	Description
Action	String	Yes	The operation that you want to perform. Set the value to ListSnapshots.
VideoId	String	Yes	The video ID.
SnapshotType	String	No	The returned snapshot type. Default value: CoverSnapshot. Valid values: CoverSnapshot: indicates thumbnail snapshots. NormalSnapshot: indicates normal snapshots initiated through the SubmitSnapshotJob operation. SpriteSnapshot: indicates sprite snapshots initiated through the SubmitSnapshotJob operation. SpriteOriginSnapshot: indicates the original snapshots that compose a sprite snapshot.
AuthTimeout	String	No	The expiration time of the snapshot address. Unit: seconds. Default value: 3600. Minimum value: 3600. If the specified value is smaller than 3600, the default value is used. This parameter is valid only when URL signing is enabled.
PageNo	Long	No	The page number. Default value: 1.
PageSize	Long	No	The number of data records per page. Default value: 20. Maximum value: 100.

Response parameters

Name	Type	Description
RequestId	String	The GUID generated by Alibaba Cloud for the request.
MediaSnapshot	MediaSnapshot	The snapshot data of the media.

Examples

Sample requests

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

Sample responses

JSON format

{
      "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":[
                {
                  "Index": 1,
                  "Url":"http://image.com/snapshot/sample00001.jpg"
                }
              ]
         }
       }
 }

Error codes

Error code	Error message	HTTP status code	Description
InvalidVideo.NotFound	The video does not exist.	404	The error message returned when the specified video does not exist.
NoSuchResource	The specified resource %s does not exist.	404	The error message returned when the specified resource does not exist.
Forbidden.IllegalStatus	Status of the video is illegal.	400	The error message returned when the video status is invalid. You can only query the snapshot data of videos in the UploadSucc, Normal, Checking, or Blocked status.