Deletes uploaded images and video snapshots that are automatically captured.
Operation description
- After you call this operation to delete an image, the source file is permanently deleted and cannot be recovered. Exercise caution when you call this operation.
- If some images are cached on Alibaba Cloud CDN points of presence (POPs), the image URLs do not immediately become invalid.
- You can call this operation to delete uploaded images and video snapshots.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- 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 Key: the condition key that is defined by the cloud service.
- 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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
vod:DeleteImage |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DeleteImageType | string | Yes | The method that is used to delete images. Valid values:
| VideoId |
ImageURLs | string | No | The URL of the image. You can obtain the value of Note
This parameter takes effect and is required only if you set DeleteImageType to ImageURL.
| https://example.aliyundoc.com/image/default/41AE7ADABBE*****.png |
ImageIds | string | No | The ID of the image. You can specify up to 20 image IDs and separate them with commas (,). You can use one of the following methods to obtain the image ID:
Note
This parameter takes effect and is required only if you set DeleteImageType to ImageId.
| bbc65bba53fed90de118a7849****,594228cdd14b4d069fc17a8c4a**** |
VideoId | string | No | The ID of the video. You can specify only one ID. You can use one of the following methods to obtain the ID:
Note
This parameter takes effect and is required only if you set DeleteImageType to VideoId.
| eb1861d2c9a8842340e989dd56**** |
ImageType | string | No | The type of images that you want to delete. The images are associated with the video. Valid values:
Note
This parameter takes effect and is required only if you set DeleteImageType to VideoId.
| All |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "25818875-5F78-4AF6-D7393642CA58****"
}
Error codes
For a list of error codes, visit the Service error codes.