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 删除一个镜像
删除一个镜像img-34vaef8fe, 当这个镜像处于使用中或者镜像Id不存在时不采取操作并返回错误码。
输入示例
GET https://cvm.tencentcloudapi.com/?Action=DeleteImages
&ImageIds.0=img-34vaef8fe
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidImageId.InShared | 镜像处于共享中。 |
InvalidImageId.IncorrectState | 镜像状态不合法。 |
InvalidImageId.Malformed | 错误的镜像Id格式。 |
InvalidImageId.NotFound | 未找到该镜像。 |
InvalidParameterValue.InvalidImageId | 镜像不允许执行该操作 |
InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
MutexOperation.TaskRunning | 同样的任务正在运行。 |