Help Center/ Video On Demand/ API Reference/ Media Asset Processing/ Setting a Thumbnail
Updated on 2025-11-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Setting a Thumbnail

Function

This API is used to set a video snapshot as the thumbnail.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v1.0/{project_id}/asset/cover

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

thumbnailUrl

Yes

String

URL of the snapshot file.

Call the API for querying a media asset to obtain the snapshot file URL of a media file based on the media asset ID.

Response Parameters

Status code: 204

Returned when the request succeeded.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

This example captures a video snapshot as the video thumbnail.

PUT https://{endpoint}/v1.0/{project_id}/asset/cover

Content-Type: application/json

{
  "thumbnailUrl": "
  https://355.cdn-vod.huaweicloud.com/shield/asset/6e76f92034ceae2fcdcef9413221511f/snapshot/sample/0.jpg"
}

Example Responses

Status code: 400

Returned when the request failed.

{
  "error_code" : "VOD.10062",
  "error_msg" : "Media asset or resource does not exist, please check."
}

Status Codes

Status Code

Description

204

Returned when the request succeeded.

400

Returned when the request failed.

Error Codes

See Error Codes.

Parent topic: Media Asset Processing