All Products
Search
Document Center

ApsaraVideo VOD:DeleteVideo

Last Updated:Nov 09, 2022

Deletes one or more videos at a time, including their mezzanine files, transcoded stream files, and thumbnail snapshots.

Operation Description

  • This operation physically deletes videos. Deleted videos cannot be recovered. Exercise caution when you call this operation.
  • You can call this operation to delete multiple videos at a time.
  • When you delete a video, its source file, transcoded stream file, and thumbnail screenshot are also deleted. However, the Alibaba Cloud Content Delivery Network (CDN) cache is not refreshed simultaneously. You can use the refresh feature in the ApsaraVideo VOD console to clear garbage data on CDN nodes. For more information, see Refresh and prefetch.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operateaccess levelResource typeconditional keywordAssociation operation
vod:DeleteVideoWrite
  • VOD
    acs:vod:*:{#accountId}:*
    without
without
vod:DeleteVideoWrite
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
VideoIdsstringYes

The list of video IDs. Separate multiple IDs with commas (,). A maximum of 20 IDs can be specified. You can obtain a video ID in one of the following ways:

  • If the video is uploaded by using the ApsaraVideo VOD console, log on to the console and choose Media Files > Audio/Video to view the ID of the video.
  • If the video is uploaded by calling the CreateUploadVideo operation, the video ID is the VideoId value in the response.
  • You can also call the SearchMedia operation to obtain the video ID, which is the VideoId value in the response.
e44ebf1147hdsa2d2adbea8b****,e44ebf11oj984adbea8****,73ab850b4f6f4b6e91d24d81d54****

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The ID of the request.

E4EBD2BF-5EB0-4476-8829-9D94E1B1****
ForbiddenVideoIdsarray

The IDs of the videos that cannot be deleted.

NoteGenerally, videos cannot be deleted if you do not have the required permissions.
string

The IDs of the videos that cannot be deleted.

NoteGenerally, videos cannot be deleted if you do not have the required permissions.
73ab850b4f6f4b6e91d24d81d54****
NonExistVideoIdsarray

The IDs of the videos that do not exist.

NoteIf the list of videos to be deleted contains one or more videos that do not exist, the IDs of these non-existing videos are returned. If none of the videos in the list exists, a 404 error is returned.
string

The IDs of the videos that do not exist.

NoteIf the list of videos to be deleted contains one or more videos that do not exist, the IDs of these non-existing videos are returned. If none of the videos in the list exists, a 404 error is returned.
e44ebf1147hdsa2d2adbea8b****

Example

Normal return example

JSONFormat

{
  "RequestId": "E4EBD2BF-5EB0-4476-8829-9D94E1B1****",
  "ForbiddenVideoIds": [
    "73ab850b4f6f4b6e91d24d81d54****"
  ],
  "NonExistVideoIds": [
    "e44ebf1147hdsa2d2adbea8b****"
  ]
}

Error codes

For a list of error codes, visit the API error center.

Common errors

The following table describes the common errors that this operation can return.

Error codeError messageHTTP status codeDescription
VideoIdsExceededMaxThe VideoIds exceeded maximum.400The error message returned because the list of video IDs exceeds the maximum length.
InvalidVideo.NotFoundThe video does not exist.404The error message returned because the video does not exist.
DeleteVideoFailedDeleting video has failed due to some unknown error.503The error message returned because the system failed to delete the video. Try again later.