删除镜像

最近更新时间:2018-10-12 16:03:07

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口(DeleteImages)用于删除一个或多个镜像。

  • 镜像状态创建中使用中时, 不允许删除。镜像状态可以通过DescribeImages获取。
  • 每个地域最多只支持创建10个自定义镜像,删除镜像可以释放账户的配额。
  • 当镜像正在被其它账户分享时,不允许删除。

默认接口请求频率限制:10次/每秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeleteImages
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
ImageIds.N Array of String 准备删除的镜像Id列表

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 示例

示例1 删除一个镜像

输入示例

https://cvm.tencentcloudapi.com/?Action=DeleteImages
&ImageIds.0=img-34vaef8fe
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、 SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集( SDK ),支持多种编程语言,能更方便的调用 API 。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InvalidImageId.InShared 镜像处于共享中。
InvalidImageId.IncorrectState 镜像状态不合法。
InvalidImageId.Malformed 错误的镜像Id格式。
InvalidImageId.NotFound 未找到该镜像。

如果有其他疑问,你也可以通过提问形式与我们联系探讨