Help Center/ Video On Demand/ API Reference/ Snapshot Management/ Listing Snapshot Task Results
Updated on 2026-03-02 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Listing Snapshot Task Results

Function

This API is used to query the list of snapshot task results.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/asset/thumbnails

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

asset_id

No

String

ID of the media asset to be snapshotted. Only one media asset is supported.

task_id

No

String

Snapshot task ID. Only one task can be queried.

offset

No

Integer

Query offset. Value range: [0,20000]. Default value: 0.

limit

No

Integer

Number of records on one page. Value range: [1,100]. Default value: 10.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when a request is sent. This parameter is mandatory for AK/SK authentication.

X-Auth-Token

Yes

String

IAM token

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total number of snapshots.

thumbnails

Array of QueryThumbnailInfo objects

Snapshot list.
Table 5 QueryThumbnailInfo

Parameter

Type

Description

task_id

String

Snapshot task.

thumbnail_para

Thumbnail object

Snapshot parameters.

Note: You will be billed for the snapshots generated. To avoid snapshot costs, you can leave these parameters unspecified.

thumbnail_count

Integer

Number of video snapshots.
Table 6 Thumbnail

Parameter

Type

Description

type

String

Snapshot capturing mode.

The options include:

  • time: Snapshots are captured by interval.

  • dots: Snapshots are captured at a specified time point.

  • quantity: Snapshots are captured based on the specified quantity and video duration.

quantity

Integer

This parameter is mandatory when type is set to quantity. Snapshots are captured based on the specified quantity and video duration.

Value range: an integer ranging from 1 to 10

quantity_time

Integer

This parameter is optional when type is set to quantity. Snapshots are captured based on the specified quantity at a specified interval.

Value range: an integer ranging from 0 to 2147483647

time

Integer

Interval at which snapshots are captured. Unit: seconds

This parameter is available when type is set to time.

Default value: 12

Value range: an integer ranging from 0 to 100

dots

Array of integers

This parameter is mandatory when type is set to dots. Array of time points when snapshots are captured.

cover_position

Integer

The value indicates which snapshot is specified as the thumbnail.

Default value: 1

format

Integer

Snapshot file format.

The options include:

  • 1: jpg

Default value: 1

aspect_ratio

Integer

Aspect ratio.

The options include:

  • 0: adaptive (the original aspect ratio is retained)

  • 1: 16:9

Default value: 0

max_length

Integer

The longest side of a snapshot.

Unit: pixel

The width of the snapshot is scaled proportionally with the longest side and input video pixel.

Default value: 480

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "total" : 0,
  "thumbnails" : [ {
    "thumbnail_para" : null
  } ]
}

Status Codes

Status Code

Description

200

Returned when the request succeeded.

400

Returned when the request failed.

Error Codes

See Error Codes.

Parent topic: Snapshot Management