1. 接口描述
接口请求域名: cvm.api3.gsesgpucloud.com。
本接口(DeleteImages)用于删除一个或多个镜像。
- 当镜像状态为
创建中
和使用中
时, 不允许删除。镜像状态可以通过DescribeImages获取。 - 每个地域最多只支持创建10个自定义镜像,删除镜像可以释放账户的配额。
- 当镜像正在被其它账户分享时,不允许删除。
默认接口请求频率限制:10次/秒。
接口更新时间:2022-10-27 11:49:19。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:DeleteImages |
Version | 是 | 否 | String | 公共参数,本接口取值:2017-03-12 |
Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
ImageIds | 是 | 否 | Array of String | 准备删除的镜像Id列表 示例值: ["img-34vaef8fe"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务ID 示例值: 543r242 |
FlowId | Int64 | 任务流转ID 示例值: 2 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidImageId.InShared | 镜像处于共享中。 |
InvalidImageId.IncorrectState | 镜像状态不合法。 |
InvalidImageId.NotFound | 未找到该镜像。 |
InvalidImageId.Malformed | 错误的镜像Id格式。 |