调用DeleteImage删除用户上传的图片及视频自动截图。

使用说明

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

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DeleteImage

系统规定参数。取值:DeleteImage

DeleteImageType String VideoId

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

  • ImageURL:根据图片URL删除指定图片。
  • ImageId:根据图片ID删除指定图片。
  • VideoId:根据视频ID删除其关联的图片。
ImageURLs String https://example.aliyundoc.com/image/default/41AE7ADABBE*****.png

图片地址,为获取图片上传地址和凭证接口返回参数ImageURL的值。支持传入多个URL,多个URL之间使用半角逗号(,)分隔。

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

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

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

视频ID。可通过以下方式获取:

  • 通过控制台上传的视频,可登录点播控制台,选择媒资库 > 音/视频查看视频ID。
  • 通过获取视频上传地址和凭证接口获取上传地址和凭证时,视频ID为返回参数VideoId的值。
  • 视频上传后,可通过搜索媒体信息接口查询视频ID,为请求后返回参数VideoId的值。
说明DeleteImageType取值为VideoId时,本参数才可用且必须传入。
ImageType String All

要删除的视频关联的图片类型。当DeleteImageType取值为VideoId时,本参数才可用且必须传入。取值:

  • CoverSnapshot:封面截图。
  • NormalSnapshot:普通截图。
  • SpriteSnapshot:雪碧截图。
  • SpriteOriginSnapshot:雪碧图原始图。
  • All(以上多种类型的图片):非All时支持多个类型,使用半角逗号(,)分隔。

返回数据

名称 类型 示例值 描述
RequestId String 25818875-5F78-4AF6-D7393642CA58****

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DeleteImage
&DeleteImageType=VideoId
&VideoId=eb1861d2c9a8842340e989dd56****
&ImageType=All
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteImageResponse>
    <RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>
</DeleteImageResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

接口错误码

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

错误代码

错误信息

HTTP 状态码

说明

NoSuchResource

The specified resource does not exist.

404

图片信息不存在。

SDK示例

建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: