调用CreateCustomImage创建自定义镜像。

使用说明

自定义镜像是您通过轻量应用服务器的快照创建的镜像。您可以通过已配置好的自定义镜像创建更多包含相同配置的轻量应用服务器,也可以将自定义镜像共享至云服务器ECS,进而通过共享镜像创建ECS实例或更换操作系统。

关于自定义镜像的更多消息,请参见自定义镜像概述

创建自定义镜像之前,您需要先创建轻量应用服务器的系统盘快照。具体操作,请参见CreateSnapshot

说明 如果您创建自定义镜像时需要服务器的数据盘数据,请先创建一份服务器的数据盘快照。

创建自定义镜像时,您需要先阅读以下注意事项:

  • 创建的自定义镜像所属地域与对应的轻量应用服务器所属地域相同。
  • 创建的自定义镜像数量上限为已创建的服务器数量的3倍,但最多不超过15个。
  • 只有服务器的系统盘快照可以直接创建自定义镜像。如果您需要自定义镜像中包含服务器的数据盘数据,在创建自定义镜像的过程中,需要手动选择对应的数据盘快照。

QPS限制

本接口的单用户QPS限制为10次/分钟。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateCustomImage

系统规定参数。取值:CreateCustomImage

RegionId String cn-hangzhou

地域ID。您可以调用ListRegions查询可用地域。

ClientToken String 123e4567-e89b-12d3-a456-426655440000

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多信息,请参见如何保证幂等性

InstanceId String ace0706b2ac4454d984295a94213****

指定的轻量应用服务器的实例ID。

ImageName String customImage-test

自定义镜像名称。长度为2~128个英文或中文字符,必须以大小写字母或中文开头或数字开头,可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

默认值:空

SystemSnapshotId String s-acscasca****

系统盘快照ID。

Description String test

镜像描述信息。

DataSnapshotId String s-acscasca****

数据盘快照ID。

返回数据

名称 类型 示例值 描述
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

请求ID。

ImageId String m-csaascsaccscs****

自定义镜像ID。

示例

请求示例

https://swas.cn-hangzhou.aliyuncs.com/?Action=CreateCustomImage
&ImageName=customImage-test
&InstanceId=ace0706b2ac4454d984295a94213****
&RegionId=cn-hangzhou
&SystemSnapshotId=s-acscasca****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateCustomImageResponse>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
<ImageId>m-csaascsaccscs****</ImageId>
</CreateCustomImageResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "CreateCustomImageResponse" : {
    "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
    "ImageId" : "m-csaascsaccscs****"
  }
}

错误码

HttpCode 错误码 错误信息 描述
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. 内部错误,请重试。如果多次尝试失败,请提交工单。

访问错误中心查看更多错误码。