Help Center/ Video On Demand/ API Reference/ Media file processing/ Sets the cover
Updated on 2024-03-01 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Sets the cover

Function

Sets a video snapshot as the cover

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 a token.

Authorization

No

String

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

X-Sdk-Date

No

String

Time when the 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 File Details to obtain the snapshot file URL of a media file based on the media file ID.

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

Captures a video snapshot as the video thumbnail.

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

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

Example Responses

Status code: 400

The information is returned when the request fails.

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

Status Codes

Status Code

Description

204

The information is returned when the request succeeds.

400

The information is returned when the request fails.

Error Codes

See Error Codes.

Parent topic: Media file processing