文档

DeleteImage - 删除图片或视频截图

调用DeleteImage删除用户上传的图片或视频截图生成的图片。

接口说明

  • 调用本接口删除图片时,会真正删除源文件,且不可逆,一旦删除,图片无法找回,请谨慎操作。
  • 调用本接口删除图片后,某些情况存在 CDN 缓存,可能出现图片 URL 不会立即失效的现象。
  • 本接口支持删除用户上传的图片及视频截图生成的图片。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:DeleteImageWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DeleteImageTypestring

图片删除操作类型。取值:

  • ImageURL:根据图片 URL 删除指定图片。
  • ImageId:根据图片 ID 删除指定图片。
  • VideoId:根据视频 ID 删除其关联的图片。
VideoId
ImageURLsstring

图片地址,为 CreateUploadImage 接口返回参数ImageURL的值。支持传入多个 URL,多个 URL 之间使用半角逗号(,)分隔,最多支持传入 20 个 URL。

说明 DeleteImageType 取值为 ImageURL 时,本参数才可用且必须传入。
https://example.aliyundoc.com/image/default/41AE7ADABBE*****.png
ImageIdsstring

图片 ID。支持传入多个 ID,多个图片 ID 之间请使用半角逗号(,)分隔,最多支持传入 20 个 ID。可通过以下方式获取图片 ID:

说明 DeleteImageType 取值为 ImageId 时,本参数才可用且必须传入。
bbc65bba53fed90de118a7849****,594228cdd14b4d069fc17a8c4a****
VideoIdstring

视频 ID,仅支持传入单个视频 ID。可通过以下方式获取:

说明 DeleteImageType 取值为 VideoId 时,本参数才可用且必须传入。
eb1861d2c9a8842340e989dd56****
ImageTypestring

要删除的视频关联的图片类型。取值:

  • CoverSnapshot:封面截图。
  • NormalSnapshot:普通截图。
  • SpriteSnapshot:雪碧截图。
  • SpriteOriginSnapshot:雪碧图原始图。
  • All:以上所有类型的图片。取值为非All时,支持选择以上多个图片类型,多个取值之间使用半角逗号(,)分隔。
说明 DeleteImageType 取值为 VideoId 时,本参数才可用且必须传入。
All

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

25818875-5F78-4AF6-D7393642CA58****

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

接口错误码

下表列举了本接口特有的错误码。

错误代码错误信息HTTP 状态码说明
NoSuchResourceThe specified resource does not exist.404图片信息不存在。