调用本接口删除用户上传的图片或视频截图生成的图片。
接口说明
调用本接口删除图片时,会真正删除源文件,且不可逆,一旦删除,图片无法找回,请谨慎操作。
当 DeleteImageType 取值为 VideoId 时,VideoId、ImageType 才可用且必须传入。
当 DeleteImageType 取值为 ImageURL 时,ImageIds、ImageURLs 才可用且必须传入。
调用本接口删除图片后,某些情况存在 CDN 缓存,可能出现图片 URL 不会立即失效的现象。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
vod:DeleteImage |
delete |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DeleteImageType |
string |
是 |
图片删除操作类型。取值:
|
VideoId |
| ImageURLs |
string |
否 |
图片地址,为 CreateUploadImage 接口返回参数 说明
当 DeleteImageType 取值为 ImageURL 时,本参数才可用且必须传入。 |
https://example.aliyundoc.com/image/default/41AE7ADABBE*****.png |
| ImageIds |
string |
否 |
图片 ID。支持传入多个 ID,多个图片 ID 之间请使用半角逗号(,)分隔,最多支持传入 20 个 ID。可通过以下方式获取图片 ID:
说明
当 DeleteImageType 取值为 ImageId 时,本参数才可用且必须传入。 |
bbc65bba53fed90de118a7849****,594228cdd14b4d069fc17a8c4a**** |
| VideoId |
string |
否 |
视频 ID,仅支持传入单个视频 ID。可通过以下方式获取:
说明
当 DeleteImageType 取值为 VideoId 时,本参数才可用且必须传入。 |
eb1861d2c9a8842340e989dd56**** |
| ImageType |
string |
否 |
要删除的视频关联的图片类型。取值:
说明
当 DeleteImageType 取值为 VideoId 时,本参数才可用且必须传入。 |
All |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| RequestId |
string |
请求 ID。 |
25818875-5F78-4AF6-D7393642CA58**** |
示例
正常返回示例
JSON格式
{
"RequestId": "25818875-5F78-4AF6-D7393642CA58****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。