Querying Snapshot Details

Function

This API is used to query snapshot 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/thumbnail/details

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	Snapshot task ID. The value is a string of 0 to 1,024 characters.
offset	No	Integer	Query offset. Value range: [0,20480]. Default value: 0.
limit	No	Integer	Number of records on one page. Value range: [1,100]. Default value: 20.

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.
thumbnail_result	Array of ThumbnailRsp objects	Snapshot list.

**Table 5** ThumbnailRsp
Parameter	Type	Description
offset	Integer	Time offset of the snapshot in the video, in seconds.
url	String	URL for accessing the snapshot.

Status code: 400

**Table 6** 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,
  "thumbnail_result" : 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

Previous topic: Deleting Snapshots of a Media Asset

Next topic: Permissions and Supported Actions

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot