1. 接口描述
接口请求域名： cvm.tencentcloudapi.com 。
本接口（DeleteImages）用于删除一个或多个镜像。
- 当镜像状态为
创建中和使用中时, 不允许删除。镜像状态可以通过DescribeImages获取。 - 每个地域最多只支持创建500个自定义镜像，删除镜像可以释放账户的配额。
- 当镜像正在被其它账户分享时，不允许删除。
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DeleteImages。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ImageIds.N | 是 | Array of String | 准备删除的镜像Id列表 示例值：["img-34vaef8fe"] |
| DeleteBindedSnap | 否 | Boolean | 是否删除镜像关联的快照 示例值：false |
| DryRun | 否 | Boolean | 检测是否支持删除镜像 示例值：true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 删除一个镜像
删除一个镜像img-34vaef8fe， 当这个镜像处于使用中或者镜像Id不存在时不采取操作并返回错误码。
输入示例
GET https://cvm.tencentcloudapi.com/?Action=DeleteImages
&ImageIds.0=img-34vaef8fe
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}
}示例2 检测镜像是否允许删除
检测镜像是否允许删除
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteImages
<公共请求参数>
{
"ImageIds": [
"img-mfih409y"
],
"DryRun": "True",
"DeleteBindedSnap": "True"
}输出示例
{
"Response": {
"RequestId": "f24aca43-5135-4c9b-81fb-734969ce4c78"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidImageId.InShared | 镜像处于共享中。 |
| InvalidImageId.IncorrectState | 镜像状态不合法。 |
| InvalidImageId.Malformed | 错误的镜像Id格式。 |
| InvalidImageId.NotFound | 未找到该镜像。 |
| InvalidParameterValue.InvalidAppIdFormat | 无效的appid。 |
| InvalidParameterValue.InvalidImageId | 镜像不允许执行该操作 |
| InvalidParameterValue.InvalidImageIdIsShared | 指定的镜像ID为共享镜像。 |
| InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
| MutexOperation.TaskRunning | 同样的任务正在运行。 |
