All Products
Search
Document Center

DeleteImage

Last Updated: Mar 04, 2019

Description

You can call this operation to delete uploaded images and automatic snapshots of videos. Note: This operation irreversibly deletes source files. Deleted images cannot be recovered. If some images are cached in CDN, their URLs are not immediately invalidated.

Request parameters

NameTypeRequiredDescription
ActionStringYesThe operation that you want to perform. Set the value to DeleteImage.
DeleteImageType StringYesThe image type.
Valid values:
  • ImageURL: indicates an image URL.
  • ImageId: indicates an image.
  • VideoId: indicates the snapshots of a video.
ImageURLs StringNoThe image URL.
Separate multiple image URLs with a comma (,).
This parameter is required if the DeleteImageType parameter is set to ImageURL.
ImageIdsStringNoThe image ID.
Separate multiple image IDs with a comma (,).
This parameter is required if the DeleteImageType parameter is set to ImageId.
VideoIdStringNoThe video ID.
This parameter is required if the DeleteImageType parameter is set to VideoId.
ImageType StringNoThe image type.
This parameter is required if the DeleteImageType parameter is set to VideoId.
Valid values:
  • CoverSnapshot: indicates thumbnail snapshots.
  • NormalSnapshot: indicates normal snapshots initiated through the SubmitSnapshotJob operation. [DO NOT TRANSLATE]
  • SpriteSnapshot: indicates sprite snapshots initiated through the SubmitSnapshotJob operation.
  • SpriteOriginSnapshot: indicates the original snapshots that compose a sprite snapshot.
  • All: indicates images of all the preceding types.If this parameter is not set to All, you can specify multiple types and separate them with a comma (,).

Response parameters

NameTypeDescription
RequestId String The GUID generated by Alibaba Cloud for the request.

Examples

Sample requests

  1. https://vod.cn-shanghai.aliyuncs.com?Action=DeleteImage&DeleteImageType=ImageURL&&mageURLs=http://xxxx,http://xxxxx&Format=JSON&<Common request parameters>

Note: For more information about common request parameters, see Common parameters.

Sample responses

JSON format

  1. {
  2. "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58"
  3. }

Error codes

The following table lists the error code that this operation can return. For more information, see Error codes.

Error codeError messageHTTP status codeDescription
NoSuchResourceThe specified resource does not exist. 404The error message returned when the specified image does not exist.