接口说明
您可以通过镜像模板定制镜像内容,并支持跨地域跨账号构建镜像。创建镜像模板前,您需要注意:
- 仅支持创建您自定义的镜像模板。
- 仅支持使用公共镜像、自定义镜像、共享镜像或者镜像族系作为源镜像进行构建。
- 通过镜像模板构建镜像时,需要创建多台中转实例辅助构建镜像,中转实例为按量计费的 ECS 实例,将收取一定的费用。更多信息,请参见按量付费。
关于构建模板内容BuildContent
,您需要注意:
FROM
命令已被弃用,不管参数BuildContent
是否设置FROM
命令,系统都会以源镜像类型BaseImageType
和源镜像BaseImage
为准进行源镜像的选取。- 一个镜像模板内容大小不能超过 16 KB。支持的命令说明详情,请参见镜像构建服务支持的命令说明。
更多信息,请参见镜像构建概述。
流控信息
授权信息
当前云产品暂无权限信息透出。
请求参数
字段名称 | 字段详情 |
---|---|
Tagarray<object> | 标签列表。 子级条数 <= 20 |
RegionIdstring | 所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 示例值:cn-hangzhou参考取值来源: DescribeRegions |
ResourceGroupIdstring | 企业资源组 ID。 示例值:rg-bp67acfmxazb4p****参考取值来源: DescribeSecurityGroups |
AddAccountarray<integer<int64>> | 目标镜像共享的阿里云账号 ID。N 的取值范围:1~20。 示例值:1234567890子级条数 <= 21 |
ToRegionIdarray<string> | 目标镜像待分发的地域列表。N 的取值范围:1~20。展开详情 示例值:cn-hangzhou子级条数 <= 21 |
BaseImageTypestring | 源镜像类型。取值范围:展开详情 示例值:IMAGE参考取值来源: DescribeImagePipelines |
BaseImagestring | 源镜像。展开详情 示例值:m-bp67acfmxazb4p****参考取值来源: DescribeImagePipelines |
Namestring | 模板名称。长度为 2~128 个字符,必须以大小写字母或中文开头,不能以 示例值:testImagePipeline |
Descriptionstring | 描述信息。长度为 2~256 个英文或中文字符,不能以 示例值:This is description. |
deprecatedImageNamestring | 目标镜像名称前缀。展开详情 示例值:testImageName参考取值来源: DescribeImages |
VSwitchIdstring | VPC 的交换机 ID。展开详情 示例值:vsw-bp67acfmxazb4p**** |
InstanceTypestring | 实例规格。您可以调用 DescribeInstanceTypes 查询不同的实例规格。展开详情 示例值:ecs.g6.large参考取值来源: DescribeInstanceTypes CreateInstance |
SystemDiskSizeinteger<int32> | 中转实例的系统盘大小。单位:GiB。取值范围:20~500。展开详情 示例值:40 |
InternetMaxBandwidthOutinteger<int32> | 中转实例的公网出带宽大小。单位:Mbit/s。取值范围:0~100。展开详情 示例值:0 |
DeleteInstanceOnFailureboolean | 镜像构建失败后是否释放中转实例。取值范围:展开详情 示例值:true |
BuildContentstring | 镜像构建模板内容。内容大小不能超过 16 KB,具体支持的命令请参见镜像构建服务支持的命令说明。 示例值:COMPONENT ic-bp12dvdzvr9k9*****
COMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.* |
ClientTokenstring | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 示例值:123e4567-e89b-12d3-a456-426655440000 |
RepairModestring | 镜像模版中的修复选项。展开详情 示例值:Standard |
deprecatedImageFamilystring | 目标镜像族系。展开详情 示例值:family参考取值来源: DescribeImages |
TestContentstring | 镜像测试模板内容。内容大小不能超过 16 KB,具体支持的命令请参见镜像构建服务支持的命令说明。 示例值:COMPONENT ic-bp12dvdzvr9k9*****
COMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.* |
ImportImageOptionsobject | 导入镜像的属性和设置。当 |
deprecatedNvmeSupportstring | 构建的目标镜像是否支持 NVMe。展开详情 示例值:auto |
AdvancedOptionsobject | 高级设置。 |
ImageOptionsobject | 目标镜像属性。 |
返回参数
字段名称 | 字段详情 |
---|---|
ImagePipelineIdstring | 镜像模板 ID。 示例值:ip-2ze5tsl5bp6nf2b3**** |
RequestIdstring | 请求 ID。 示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |