Help Center/ Video On Demand/ API Reference/ Snapshot Management/ Deleting Snapshots of a Media Asset
Updated on 2026-03-20 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting Snapshots of a Media Asset

Function

This API is used to delete the snapshots of a media asset. A maximum of 10 snapshots can be deleted at a time.

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, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    vod:thumbnail:delete

    Write

    assets *

    vod:AssetLabel

    -

    -

URI

DELETE /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

Media asset ID.

task_id

No

Array of strings

Deleting snapshots generated in a specified task. A maximum of 10 snapshots can be deleted at a time.

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

token

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

delete_result_array

Array of DeleteThumbnailResult objects

Result of the snapshot deletion task.
Table 5 DeleteThumbnailResult

Parameter

Type

Description

asset_id

String

ID of the media asset whose snapshots are deleted.

task_id

String

ID of the task for deleting the snapshots.

status

String

Deletion status.

Options:

  • DELETED

  • FAILED

  • UNKNOW

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.

{
  "delete_result_array" : [ {
    "task_id" : "2xxxxx30",
    "status" : "DELETED"
  } ]
}

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