All Products
Search
Document Center

ApsaraVideo VOD:ListSnapshots

Last Updated:May 11, 2024

Queries the snapshots that are captured from the specified media.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vod:ListSnapshotsList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VideoIdstringYes

The ID of the video.

d3e680e618708fbf2cae7cc931****
SnapshotTypestringNo

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
AuthTimeoutstringNo

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
PageSizestringNo

The number of entries to return on each page. Default value: 20. Maximum value: 100.

20
PageNostringNo

The number of the page to turn. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The ID of the request.

25818875-5F78-4AF6-D7393642CA58****
MediaSnapshotobject

The snapshot data of the media.

CreationTimestring

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
Regularstring

The rule for generating snapshot URLs.

http://example.aliyundoc.com/snapshot/sample{SnapshotCount}.jpg
Totallong

The total number of snapshots.

100
JobIdstring

The ID of the snapshot job.

ad90a501b1b9472374ad005046****
Snapshotsobject []

The snapshot data.

Indexlong

The index of the snapshot.

1
Urlstring

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 codeError messageHTTP status codeDescription
InvalidVideo.NotFoundThe video does not exist.404The error message returned because the video does not exist.
NoSuchResourceThe specified resource %s does not exist.404The error message returned because the specified resource does not exist.
Forbidden.IllegalStatusStatus of the video is illegal.400The 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.