1. 接口描述
接口请求域名： cvm.api3.gsesgpucloud.com。
本接口(CreateImage)用于将实例的系统盘制作为新镜像，创建后的镜像可以用于创建实例。
默认接口请求频率限制：10次/秒。
接口更新时间：2022-10-27 11:48:25。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateImage |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 否 | 否 | String | 需要制作镜像的实例ID 示例值： ins-2v3sqe2t |
| ImageName | 是 | 否 | String | 镜像名称 示例值： MyImageName |
| ImageDescription | 否 | 否 | String | 镜像描述 示例值： MyImageDescription |
| ForcePoweroff | 否 | 否 | String | 软关机失败时是否执行强制关机以制作镜像 示例值： true |
| Sysprep | 否 | 否 | String | 创建Windows镜像时是否启用Sysprep 示例值： false |
| Reboot | 否 | 否 | String | 实例处于运行中时，是否允许关机执行制作镜像任务。 示例值： false |
| DataDiskIds | 否 | 否 | Array of String | 基于实例创建整机镜像时，指定包含在镜像里的数据盘Id 示例值： ["disk-6gabakqz"] |
| SnapshotIds | 否 | 否 | Array of String | 基于快照创建镜像，指定快照ID，必须包含一个系统盘快照。不可与InstanceId同时传入。 示例值： ["snap-kso6f712", "snap-l3rrf322"] |
| DryRun | 否 | 否 | Bool | 检测本次请求的是否成功，但不会对操作的资源产生任何影响 示例值： false |
| SoftPoweroff | 否 | 否 | Array of String | 是否执行软关机以制作镜像。 示例值： false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ImageId | String | 镜像ID 示例值： img-2v3sqe2t |
| TaskId | String | 任务ID 示例值： 4532455 |
| FlowId | Int64 | 任务流转ID 示例值： 2 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidInstanceId.NotFound | 没有找到相应实例。 |
| ImageQuotaLimitExceeded | 镜像配额超过了限制。 |
| InvalidInstance.NotSupported | 不被支持的实例。 |
| InvalidImageName.Duplicate | 镜像名称与原有镜像重复。 |
| InvalidParameter.ValueTooLarge | 参数长度超过限制。 |
| MutexOperation.TaskRunning | 同样的任务正在运行。 |