Query video snapshots using ListSnapshots - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries snapshots generated by video snapshot jobs and thumbnail snapshots automatically generated by the system during video upload.

Operation description

If multiple snapshot jobs have been initiated for a video, this operation returns only the data of the most recent successful snapshot job.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:ListSnapshots

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	Yes	The video ID. You can obtain the video ID by using one of the following methods: Log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the video ID. Obtain the video ID from the response of the CreateUploadVideo operation that you call to obtain the upload URL and credential. Obtain the video ID from the response of the SearchMedia operation that you call to query videos.	d3e680e618708fbf2cae7cc931****
SnapshotType	string	No	The type of snapshots to return. Valid values: CoverSnapshot (default): thumbnail snapshots. NormalSnapshot: normal snapshots. SpriteSnapshot: sprites. SpriteOriginSnapshot: original images of sprites. WebVttSnapshot: WebVTT snapshots.	CoverSnapshot
AuthTimeout	string	No	The expiration time of the snapshot access URL. Default value: 3600. Minimum value: 3600. Unit: seconds. This parameter takes effect only if URL authentication is enabled. If the specified value is less than 3600 seconds, the default value of 3600 seconds is used. If the returned URL is an OSS URL, the maximum value is 2592000 (30 days) to reduce security risks to the origin server.	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 elements

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

Examples

Success response

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.