Help Center/ Video On Demand/ API Reference/ Media file management/ Deletes a media asset
Updated on 2024-12-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deletes a media asset

Function

Deletes a media asset

Constraints

Media assets that are being transcoded, reviewed, or captured cannot be deleted.

URI

DELETE /v1.0/{project_id}/asset

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

asset_id

Yes

Array of strings

Media file ID. Multiple media files can be deleted at a time. Use commas (,) to separate them during batch deletion.The value ranges from 1 to 10.

delete_type

No

String

Deletion type. If this parameter is set to origin, only the source file is deleted and the transcoded file is retained. If this parameter is left empty, the entire media file is deleted by default.

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

delete_result_array

Array of DeleteResult objects

Result of the media asset deletion task
Table 5 DeleteResult

Parameter

Type

Description

asset_id

String

Media asset ID assigned by VOD. This parameter can only be queried but cannot be modified.

status

String

Status

Possible values are:

  • DELETED: The task has been deleted.

  • FAILED: The deletion failed.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

Deletes a media file.

DELETE https://{endpoint}/v1.0/{project_id}/asset?asset_id={asset_id}

Example Responses

Status code: 200

The information is returned when the request succeeds.

{
  "delete_result_array" : [ {
    "asset_id" : "f488337c31c8e4622f1590735b134c65",
    "status" : "DELETED"
  } ]
}

Status code: 403

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

200

The information is returned when the request succeeds.

403

The information is returned when the request fails.

Error Codes

See Error Codes.

Parent topic: Media file management