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 exist for a video, you can call this operation to query information about the latest snapshot.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
vod:ListSnapshots | list |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
VideoId | string | Yes | The ID of the video. You can use one of the following methods to obtain the ID:
| d3e680e618708fbf2cae7cc931**** |
SnapshotType | string | No | The type of snapshots to return. Valid values:
| CoverSnapshot |
AuthTimeout | string | No | The validity period of the snapshot URL. Default value: 3600. Minimum value: 3600. Unit: seconds.
| 3600 |
PageSize | string | No | The number of entries per page. Default value: 20. Maximum value: 100. | 20 |
PageNo | string | No | The page number. Default value: 1. | 1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"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. |