接口说明
注意事项
-
本接口为异步接口,创建自定义镜像请求发送成功后会返回镜像 ID,镜像的创建不是立即完成的,需要调用 DescribeImage 查看镜像信息,当返回信息中的状态为
Available
时代表镜像创建成功并可用。更多信息,请参见自定义镜像概述。 -
查询 ECS 实例信息时,如果返回数据中包含{"OperationLocks": {"LockReason" : "security"}},则禁止创建自定义镜像。
-
建议在创建镜像时配置镜像检测参数
DetectionStrategy
,有助于系统帮助优化您的镜像。更多信息,请参见镜像检测概述。
以下描述了三种通过该接口创建自定义镜像的方法。请求参数的优先级为:InstanceId > DiskDeviceMapping > SnapshotId,若您的请求中同时含有两个及以上参数,默认以优先级更高的参数为准创建镜像。
-
根据实例创建自定义镜像:指定实例 ID(
InstanceId
)。- 实例的状态必须为运行中(
Running
)或者已停止(Stopped
)。 - 接口调用成功后,实例的每块云盘均会新增一份快照。
注意 由于运行中的实例存在缓存数据未落盘的情况,可能导致创建的自定义镜像数据与实例数据不完全一致,因此建议您停止实例( StopInstances )后创建镜像。 - 实例的状态必须为运行中(
-
根据快照创建自定义镜像(指定的快照不能是 2013 年 7 月 15 日(含)之前创建的快照。)
- 使用系统盘快照创建自定义镜像:只需指定实例系统盘的快照 ID(
SnapshotId
)。 - 使用系统盘快照和数据盘快照创建自定义镜像:这需要建立几块云盘的数据关联(
DiskDeviceMapping
)。- 系统盘快照只能被指定一个。
- 数据盘快照可以指定多个,最多不能超过 16 块。不指定
DiskDeviceMapping.N.SnapshotId
时会创建一个默认容量的空数据盘。
- 使用系统盘快照创建自定义镜像:只需指定实例系统盘的快照 ID(
流控信息
请求参数
字段名称 | 字段详情 |
---|---|
RegionIdstring | 镜像所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 示例值:cn-hangzhou参考取值来源: DescribeRegions |
SnapshotIdstring | 用于创建自定义镜像的快照 ID。展开详情 示例值:s-bp17441ohwkdca0****参考取值来源: CopySnapshot CreateSnapshot DescribeSnapshots |
InstanceIdstring | 实例 ID。根据实例创建自定义镜像时,必须指定该参数。 示例值:i-bp1g6zv0ce8oghu7****参考取值来源: RunInstances StopInstances StartInstances CreateInstance RebootInstances DescribeInstances ModifyManagedInstance RenewReservedInstances DetachInstanceRamRole AttachInstanceRamRole DeregisterManagedInstance PurchaseReservedInstancesOffering |
ImageNamestring | 镜像名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头,不能以 http://和 https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。 示例值:TestCentOS参考取值来源: DescribeImages |
ImageFamilystring | 镜像族系名称。长度为 2~128 个英文或中文字符。必须以大小写字母或中文开头,不能以 aliyun 和 acs:开头,不能包含 http://或者 https://。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。 示例值:hangzhou-daily-update参考取值来源: DescribeImages |
ImageVersionstring | 镜像版本。展开详情 示例值:2017011017参考取值来源: DescribeImages |
Descriptionstring | 镜像的描述信息。长度为 2~256 个英文或中文字符,不能以 http://或 https://开头。 示例值:ImageTestDescription |
Platformstring | 操作系统,指定数据盘快照做镜像的系统盘后,需要通过 Platform 确定系统盘的操作系统发行版。取值范围:展开详情 示例值:CentOS |
BootModestring | 修改镜像的启动模式。取值范围:展开详情 示例值:BIOS枚举值:BIOSUEFIUEFI-Preferred |
Architecturestring | 系统架构,指定数据盘快照做镜像的系统盘后,需要通过 Architecture 确定系统盘的系统架构。取值范围:展开详情 示例值:x86_64 |
ClientTokenstring | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 示例值:123e4567-e89b-12d3-a456-426655440000 |
ResourceGroupIdstring | 自定义镜像所在的资源组 ID。如果不设置该参数值,创建的镜像属于默认资源组。展开详情 示例值:rg-bp67acfmxazb4p****参考取值来源: DescribeSecurityGroups |
DiskDeviceMappingarray<object> | 创建自定义镜像使用的云盘和快照信息集合。如果需要根据系统盘快照和数据盘快照创建自定义镜像,请使用该参数指定快照。 子级条数 <= 17 |
Tagarray<object> | 标签列表。 子级条数 <= 20 |
DetectionStrategystring | 镜像检测策略,不配置此参数时不触发检测。仅支持标准(Standard)检测模式。 展开详情 示例值:Standard |
Featuresobject | 镜像特性相关属性。 |
返回参数
字段名称 | 字段详情 |
---|---|
ImageIdstring | 镜像 ID。 示例值:m-bp146shijn7hujku**** |
RequestIdstring | 请求 ID。 示例值:C8B26B44-0189-443E-9816-******* |