CreateImagePipeline
创建一个镜像模板。镜像模板可用于构建镜像
服务地址:
华东1 金融云
输入参数
只看必填
Tag标签列表
0标签列表
Key标签键
Value标签值
RegionId所属的地域ID
ResourceGroupId企业资源组ID
AddAccount目标镜像共享的阿里云账号ID
0目标镜像共享的阿里云账号ID
ToRegionId目标镜像待分发的地域列表
0目标镜像待分发的地域列表
BaseImageType源镜像类型
BaseImage源镜像
Name模板名称
Description描述信息
ImageName目标镜像名称前缀
VSwitchIdVPC的交换机ID
InstanceType实例规格
SystemDiskSize中转实例的系统盘大小
InternetMaxBandwidthOut中转实例的公网出带宽大小
DeleteInstanceOnFailure镜像构建失败后是否释放中转实例
请选择布尔值
BuildContent镜像构建模板内容
RepairMode镜像模版中的修复选项
ImageFamily目标镜像族系
TestContent镜像测试模板内容
ImportImageOptions导入镜像的属性和设置
Architecture指定数据盘快照做镜像的系统盘后
OSType操作系统类型
Platform操作系统版本
BootMode修改镜像的启动模式
LicenseType导入镜像后
DiskDeviceMappings创建的自定义镜像信息列表
0
OSSBucket镜像文件所在的OSS Bucket
OSSObject镜像上传至OSS Bucket后
Format镜像格式
DiskImageSize导入镜像后
Features镜像特性相关属性
NvmeSupport导入的原始镜像是否支持 NVMe
RetainImportedImage该参数正在邀测中
请选择布尔值
NvmeSupport构建的目标镜像是否支持 NVMe
AdvancedOptions高级设置
RetainCloudAssistant是否保留云助手
请选择布尔值
ImageNameSuffix是否禁用目标镜像名称自动增加后缀
ImageOptions目标镜像属性
ImageName目标镜像名称前缀
ImageFamily目标镜像族系
Description描述信息
ImageFeatures目标镜像特性相关属性
NvmeSupport构建的目标镜像是否支持 NVMe
ImageTags目标镜像标签
0
Key标签键
Value资源的标签值
幂等性参数
ClientToken保证请求幂等性
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

您可以通过镜像模板定制镜像内容,并支持跨地域跨账号构建镜像。创建镜像模板前,您需要注意:

  • 仅支持创建您自定义的镜像模板。
  • 仅支持使用公共镜像、自定义镜像、共享镜像或者镜像族系作为源镜像进行构建。
  • 通过镜像模板构建镜像时,需要创建多台中转实例辅助构建镜像,中转实例为按量计费的 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 个字符,必须以大小写字母或中文开头,不能以http://https://开头。可以包含中文、英文、数字、半角冒号(:)、下划线(_)、半角句号(.)或者短划线(-)。展开详情

示例值:testImagePipeline
Descriptionstring

描述信息。长度为 2~256 个英文或中文字符,不能以http://https://开头。

示例值: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

导入镜像的属性和设置。当BaseImageType=OSS时,需要设置。

deprecatedNvmeSupportstring

构建的目标镜像是否支持 NVMe。展开详情

示例值:auto
AdvancedOptionsobject

高级设置。

ImageOptionsobject

目标镜像属性。

返回参数

字段名称字段详情
ImagePipelineIdstring

镜像模板 ID。

示例值:ip-2ze5tsl5bp6nf2b3****
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
变更历史
变更时间变更内容概要操作
2025-02-28
变更错误码400
变更请求参数AdvancedOptions
新增请求参数ImageOptions
2025-01-13
变更错误码400
变更错误码403
变更错误码404
变更请求参数BaseImage
新增请求参数ImportImageOptions
新增请求参数NvmeSupport
新增请求参数AdvancedOptions
2024-12-26
变更错误码403
2024-10-10
变更错误码400
变更错误码404
新增请求参数RepairMode
新增请求参数ImageFamily
新增请求参数TestContent
删除返回参数
2023-03-28
变更错误码404