Use DeleteImage to delete images by URL image ID or video ID - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

When you call this operation to delete images, the source files are permanently deleted. This action is irreversible. Once deleted, the images cannot be recovered. Proceed with caution.
When DeleteImageType is set to VideoId, VideoId and ImageType are available and required.
When DeleteImageType is set to ImageURL, ImageIds and ImageURLs are available and required.
After you call this operation to delete images, CDN caches may still exist in some cases, which means the image URLs may not become invalid immediately.

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:DeleteImage

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DeleteImageType	string	Yes	The type of image deletion operation. Valid values: ImageURL: deletes images based on image URLs. ImageId: deletes images based on image IDs. VideoId: deletes images associated with a video based on the video ID.	VideoId
ImageURLs	string	No	The image URLs. The value is the `ImageURL` parameter returned by the CreateUploadImage operation. Separate multiple URLs with commas (,). A maximum of 20 URLs are supported. Note This parameter is available and required only when DeleteImageType is set to ImageURL.	https://example.aliyundoc.com/image/default/41AE7ADABBE*****.png
ImageIds	string	No	The image IDs. Separate multiple IDs with commas (,). A maximum of 20 IDs are supported. You can obtain image IDs by using the following methods: Log on to the ApsaraVideo VOD console and choose Media Files > Image to view the IDs. Obtain the IDs from the response of the CreateUploadImage operation that is called to obtain the upload URL and credential. Obtain the IDs from the response of the SearchMedia operation that is called to query images. Note This parameter is available and required only when DeleteImageType is set to ImageId.	bbc65bba53fed90de118a7849**,594228cdd14b4d069fc17a8c4a**
VideoId	string	No	The video ID. Only a single video ID is supported. You can obtain the video ID by using the following methods: Log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the video ID. Obtain the ID from the response of the CreateUploadVideo operation that is called to obtain the upload URL and credential. Obtain the ID from the response of the SearchMedia operation that is called to query videos. Note This parameter is available and required only when DeleteImageType is set to VideoId.	eb1861d2c9a8842340e989dd56****
ImageType	string	No	The type of images associated with the video that you want to delete. Valid values: CoverSnapshot: thumbnail snapshot. NormalSnapshot: regular snapshot. SpriteSnapshot: sprite snapshot. SpriteOriginSnapshot: sprite source image. All: all of the preceding image types. If the value is not `All`, you can specify multiple image types. Separate multiple values with commas (,). Note This parameter is available and required only when DeleteImageType is set to VideoId.	All

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.