Call the DeleteVideo API to batch delete videos - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

Usage notes

This operation physically deletes videos. Deleted videos cannot be recovered. Proceed with caution.
Batch deletion is supported.
When you delete a video, the source files are deleted, including the video source file, transcoded stream files, and thumbnails. However, the CDN cache is not refreshed through synchronization. If your business requires it, use the purge feature in the ApsaraVideo VOD console to clear stale data from the point of presence. Related operations: see Purge and prefetch.

QPS limit

The single-user QPS limit for this operation is 30 calls per second. If the limit is exceeded, the API invoke is throttled, which may affect your business. Invoke this operation appropriately. For more information, see QPS limit.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:DeleteVideo

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VideoIds	string	No	The list of video IDs. Separate multiple IDs with commas (,). A maximum of 20 IDs are supported. You can obtain video IDs by using the following methods: For videos uploaded through the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the video ID. When you upload a video by calling the CreateUploadVideo operation, the video ID is the value of the VideoId parameter in the response. After a video is uploaded, you can call the SearchMedia operation to query the video ID, which is the value of the VideoId parameter in the response.	e44ebf1147hdsa2d2adbea8b**,e44ebf11oj984adbea8,73ab850b4f6f4b6e91d24d81d54**
ReferenceIds	string	No	The list of custom IDs. Separate multiple IDs with commas (,). A maximum of 20 IDs are supported.	123-123,1234-1234

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	E4EBD2BF-5EB0-4476-8829-9D94E1B1****
ForbiddenVideoIds	array	The list of video IDs for which the operation is forbidden. Note This is typically caused by insufficient permissions.
	string	The list of video IDs for which the operation is forbidden. Note This is typically caused by insufficient permissions.	73ab850b4f6f4b6e91d24d81d54****
NonExistVideoIds	array	The list of video IDs that do not exist.
	string	The list of video IDs that do not exist. Note If some of the video IDs in the request do not exist, those non-existent video IDs are returned. If all video IDs in the request do not exist, a 404 error is returned.	e44ebf1147hdsa2d2adbea8b****
NonExistReferenceIds	array	The list of custom IDs that do not exist.
	string	The list of custom IDs that do not exist.	123-123

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.