通过快照创建用户自定义镜像。
接口说明
自定义镜像是您通过轻量应用服务器的快照创建的镜像。您可以通过已配置好的自定义镜像创建更多包含相同配置的轻量应用服务器，也可以将自定义镜像共享至云服务器 ECS，进而通过共享镜像创建 ECS 实例或更换操作系统。 关于自定义镜像的更多消息，请参见自定义镜像概述。
创建自定义镜像之前，您需要先创建轻量应用服务器的系统盘快照。具体操作，请参见 CreateSnapshot 。
创建自定义镜像时，您需要先阅读以下注意事项：
-
创建的自定义镜像所属地域与对应的轻量应用服务器所属地域相同。
-
创建的自定义镜像数量上限为已创建的服务器数量的 3 倍，但最多不超过 15 个。
-
只有服务器的系统盘快照可以直接创建自定义镜像。如果您需要自定义镜像中包含服务器的数据盘数据，在创建自定义镜像的过程中，需要手动选择对应的数据盘快照。
-
如果轻量应用服务器到期或者退款后释放，该服务器对应的自定义镜像也会随之释放。
-
重置系统或更换镜像会清除服务器上的磁盘数据，请您根据需要做好数据备份。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| swas-open:CreateCustomImage | create |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。您可以调用 ListRegions 查询可用地域。 | cn-hangzhou |
| ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
| InstanceId | string | 是 | 指定的轻量应用服务器的实例 ID。 | ace0706b2ac4454d984295a94213**** |
| ImageName | string | 是 | 自定义镜像名称。长度为 2~128 个英文或中文字符，必须以大小写字母或中文开头或数字开头，可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。 默认值：空 | customImage-test |
| SystemSnapshotId | string | 否 | 系统盘快照 ID。 | s-acscasca**** |
| Description | string | 否 | 镜像描述信息。 | test |
| DataSnapshotId | string | 否 | 数据盘快照 ID。 | s-acscasca**** |
| Tag | array<object> | 否 | 标签列表，最多包含 20 个子项。 | |
| object | 否 | 标签。 | ||
| Key | string | 否 | 为自定义镜像指定的标签键。N 的取值范围：1~20。 一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。 | TestKey |
| Value | string | 否 | 为自定义镜像指定的标签值。N 的取值范围：1~20。 一旦传入该值，可以为空字符串。最多支持 64 个字符，不能包含 http://或者 https://。 | TestValue |
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-aek2bti7cf7**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"ImageId": "m-csaascsaccscs****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParam.DataSnapshotIdNotFound | The specified parameter dataSnapshotId is not found. | 指定的数据盘快照不存在。 |
| 400 | InvalidParam.SystemSnapshotIdNotFound | The specified parameter systemSnapshotId is not found. | 指定的系统盘快照不存在。 |
| 400 | InvalidParam.IllegalImageName | The specified parameter imageName is illegal. | 指定的镜像名称不合法。 |
| 400 | ImageNameAlreadyExist | The image name already exists. | 镜像名称已存在。 |
| 400 | CustomImageQuotaLimit | The maximum number of custom image in this region is exceeded. | 您的自定义镜像在该地域下已达上限。 |
| 400 | InvalidParam.SystemSnapshotIdNotSupport | You cannot create custom images in the specified parameter system snapshotId. | 指定的参数系统快照不支持创建自定义镜像。 |
| 403 | IncorrectInstanceStatus | The state of the current instance does not support this operation. | 当前实例的状态不支持此操作。 |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的实例不存在，请您检查实例ID是否正确。 |
| 500 | InternalError | An error occurred while processing your request. | 内部错误，请重试。如果多次尝试失败，请提交工单。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-08-08 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-05-29 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-04-17 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-02-20 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2021-10-27 | 新增 OpenAPI | 查看变更详情 |
| 2021-10-27 | OpenAPI 错误码发生变更 | 查看变更详情 |