调用CreateImagePipeline创建一个镜像模板。镜像模板可用于构建镜像。

接口说明

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

  • 仅支持创建您自定义的镜像模版。
  • 仅支持设置Linux系统的公共镜像、自定义镜像、共享镜像或者镜像族系。
  • 通过镜像模版构建镜像时,需要创建中转实例辅助构建镜像,中转实例为按量计费的ECS实例,将收取一定的费用。更多信息,请参见按量付费

关于构建模板内容BuildContent,您需要注意:

  • 如果参数BuildContent设置了FROM命令,则源镜像类型BaseImageType和源镜像BaseImage设置的值会被FROM命令覆盖。
  • 如果参数BuildContent没有设置FROM命令,则系统会自动将源镜像类型BaseImageType和源镜像BaseImage构成的FROM命令添加到模板内容的首行,格式为<BaseImageType>:<BaseImage>
  • 一个镜像模板内容可以通过Dockerfile编辑,然后将内容传入BuildContent参数。内容大小不能超过16 KB,最大支持127个命令。支持的命令说明详情,请参见镜像构建服务支持的命令说明

不支持通过API使用镜像组件快速完成镜像模板的创建,仅控制台操作支持该功能。更多信息,请参见镜像构建概述

调试

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

请求参数

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

系统规定参数。取值:CreateImagePipeline

BaseImage String m-bp67acfmxazb4p****

源镜像。

  • BaseImageType=IMAGE时,该参数取值为自定义镜像ID。
  • BaseImageType=IMAGE_FAMILY时,该参数取值为镜像族系名称。
BaseImageType String IMAGE

源镜像类型。取值范围:

  • IMAGE:自定义镜像。
  • IMAGE_FAMILY:镜像族系。
RegionId String cn-hangzhou

所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

Tag.N.Key String TestKey

标签键。N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以aliyun和acs:开头,不能包含http://或者https://。

Tag.N.Value String TestValue

标签值。N的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持128个字符,不能以acs:开头,不能包含http://或者https://。

ResourceGroupId String rg-bp67acfmxazb4p****

企业资源组ID。

Name String testImagePipeline

模板名称。长度为2~128个字符,必须以大小字母或中文开头,不能以http://和https://开头。可以包含中文、英文、数字、半角冒号(:)、下划线(_)、英文句号(.)或者短划线(-)。

说明 不设置 Name时,默认使用 ImagePipelineId返回值。
Description String This is description.

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

ImageName String testImageName

目标镜像名称前缀。长度为2~64个字符,必须以大小字母或中文开头,不能以http://和https://开头。可以包含中文、英文、数字、半角冒号(:)、下划线(_)、英文句号(.)或者短划线(-)。

最终完整的镜像名称由系统自动拼接名称前缀与构建任务ID(ExecutionId),格式为{ImageName}_{ExecutionId}

VSwitchId String vsw-bp67acfmxazb4p****

VPC的交换机ID。

不设置参数值时,默认创建新的VPC与交换机,请确保您账号下VPC资源配额充足,更多信息,请参见使用限制

InstanceType String ecs.g6.large

实例规格。您可以调用DescribeInstanceTypes查询不同的实例规格。

不设置参数值时,默认按vCPU和内存最小的原则,自动设置实例规格,并受实例规格的库存影响。例如,默认选择ecs.g6.large实例规格,如果库存不足,将选择ecs.g6.xlarge实例规格。

SystemDiskSize Integer 40

中转实例的系统盘大小。单位:GiB。取值范围:20~500

默认值:40

InternetMaxBandwidthOut Integer 0

中转实例的公网出带宽大小。单位:Mbit/s。取值范围:0~100

默认值:0

DeleteInstanceOnFailure Boolean true

镜像构建失败后是否释放中转实例。取值范围:

  • true:释放
  • false:不释放

默认值:true

说明 中转实例如果没有成功启动,则实例默认不保留。
BuildContent String FROM IMAGE:m-bp67acfmxazb4p****

镜像模板内容。内容大小不能超过16 KB,最大支持127个命令。具体支持的命令请参见接口说明。

AddAccount.N RepeatList 1234567890

目标镜像共享的阿里云账号ID。N的取值范围:1~20

ToRegionId.N RepeatList cn-hangzhou

目标镜像待分发的地域列表。N的取值范围:1~20

不设置参数值时,默认只在当前地域创建镜像。

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

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

返回数据

名称 类型 示例值 描述
ImagePipelineId String ip-2ze5tsl5bp6nf2b3****

镜像模板ID。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=CreateImagePipeline
&BaseImage=m-bp67acfmxazb4p****
&BaseImageType=IMAGE
&RegionId=cn-hangzhou
&Name=testImagePipeline
&BuildContent=FROM IMAGE:m-bp67acfmxazb4p****
&<公共请求参数>

正常返回示例

XML格式

<CreateImagePipelineResponse>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
      <ImagePipelineId>ip-2ze5tsl5bp6nf2b3****</ImagePipelineId>
</CreateImagePipelineResponse>

JSON格式

{
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E", 
    "ImagePipelineId": "ip-2ze5tsl5bp6nf2b3****"
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidImage.NotFound %s 指定的参数值有误,具体信息请参见错误信息%s占位符的实际返回结果。
404 InvalidResourceGroup.NotFound The ResourceGroup provided does not exist in our records. 资源组并不在记录中。

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