ListSnapshots - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Queries the snapshots that are captured by submitting snapshot jobs or snapshots that are generated by the system when you upload the video.

Operation description

If multiple snapshots of a video exist, the data of the latest snapshot is returned.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	Yes	The ID of the video.	d3e680e618708fbf2cae7cc931****
SnapshotType	string	No	The type of snapshots that are returned. Valid values: CoverSnapshot: thumbnail snapshot NormalSnapshot: normal snapshot SpriteSnapshot: sprite snapshot SpriteOriginSnapshot: sprite source snapshot WebVttSnapshot: WebVTT snapshot	CoverSnapshot
AuthTimeout	string	No	The validity period of the snapshot URL. Unit: seconds. Default value: 3600. Minimum value: 3600. This parameter only takes effect when URL authentication is enabled. If the specified validity period is less than 3600 seconds, the default value is 3600. If an Object Storage Service (OSS) URL is returned, the maximum validity period is limited to 2592000 seconds (30 days) to reduce security risks of the origin.	3600
PageSize	string	No	The number of entries to return on each page. Default value: 20. Maximum value: 100.	20
PageNo	string	No	The number of the page to turn. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object	The returned data.
RequestId	string	The ID of the request.	25818875-5F78-4AF6-D7393642CA58****
MediaSnapshot	object	The snapshot data of the media.
CreationTime	string	The time when the snapshot job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2017-12-20T12:23:45Z
Regular	string	The rule for generating snapshot URLs.	http://example.aliyundoc.com/snapshot/sample{SnapshotCount}.jpg
Total	long	The total number of snapshots.	100
JobId	string	The ID of the snapshot job.	ad90a501b1b9472374ad005046****
Snapshots	array<object>	The snapshot data.
	object	The snapshot data.
Index	long	The index of the snapshot.	1
Url	string	The URL of the snapshot.	http://example.aliyundoc.com/snapshot/sample00001****.jpg

Examples

Sample success responses

JSONformat

{
  "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"
        }
      ]
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Common errors

The following table describes the common errors that this operation can return.

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