StartImagePipelineExecution - 通过一个镜像模板执行构建镜像的任务

更新时间:2025-02-19 03:01:10

调用StartImagePipelineExecution通过一个镜像模板执行构建镜像的任务。

接口说明

  • 镜像模板创建好之后,需要通过该接口执行构建镜像的任务,系统将根据镜像模板设置好的参数进行构建、分发、共享镜像。
  • 同一个镜像模板,同一时间只能执行一个构建镜像任务。取消构建镜像任务(CancelImagePipelineExecution)可同时执行多次,并且取消构建镜像任务和构建镜像任务之间互不干扰。
  • 执行镜像构建模板时,需要创建多台中转实例辅助构建镜像,中转实例为按量计费的 ECS 实例,将收取一定的费用。更多信息,请参见按量付费

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
ecs:StartImagePipelineExecutionupdate
*ImagePipeline
acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId}

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
TemplateTagdeprecatedarray<object>
说明
该参数已废弃。
object
Keystring
说明
该参数已废弃。
null
Valuestring
说明
该参数已废弃。
null
Tagarray<object>

标签列表。

object

标签对象。

Keystring

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

TestKey
Valuestring

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

TestValue
ImagePipelineIdstring

镜像模板 ID。

ip-2ze5tsl5bp6nf2b3****
ClientTokenstring

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

123e4567-e89b-12d3-a456-426655440000

返回参数

名称类型描述示例值
名称类型描述示例值
object
ExecutionIdstring

构建任务 ID。

exec-5fb8facb8ed7427c****
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "ExecutionId": "exec-5fb8facb8ed7427c****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
400InvalidImage.OsTypeUnsupportedThe specified base image does not support image building.指定的基础镜像操作系统不支持进行镜像构建。
400InvalidParameter.BuildContent%s.构建模板内容无效。
400InvalidParameter.TestContent%s.测试模板的内容无效。
400InvalidImageComponent.NotSupported%s.指定的镜像组件不可用。
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.标签中存在重复的键,请保持键的唯一性。
400InvalidTagKey.MalformedThe specified Tag.N.Key is not valid. Tag keys cannot be empty or null, support up to 128 characters, cannot start with "aliyun" or "acs:", and cannot contain "http://" or "https://".指定的标签键无效。标签键不能为空或 null,最多支持 128 个字符,不能以“aliyun”或“acs:”开头,不能包含“http://”或“https://”。
400InvalidTagValue.MalformedThe specified Tag.N.Value is not valid. Tag values support up to 128 characters, and cannot contain "http://" or "https://".指定的标签值无效。标签值最多支持 128 个字符,并且不能包含“http://”或“https://”。
403InvalidImagePipeline.HasRunningExecution%s-
403InvalidImagePipeline.OSSObjectNotAuthorizedThe ImportImageOptions.DiskDeviceMappings.OSSObject of the specified ImagePipeline is not allowed to access.指定的入参ImagePipeline中的ImportImageOptions.DiskDeviceMappings.OSSObject不允许被访问。
403InvalidImagePipeline.OSSObjectNeedRestoreThe ImportImageOptions.DiskDeviceMappings.OSSObject of the specified ImagePipeline is an archived object and needs to be restored first.指定的ImagePipelineImportImageOptions.DiskDeviceMappings.OSSObject是一个归档对象,需要先进行恢复。
403InvalidOperation.NoRightAccessOSSECS service is not authorized to access your OSS. Check your RAM roles and policies, and ensure that ecs.aliyuncs.com is authorized to assume AliyunECSImageImportDefaultRole.ECS服务没有权限访问您的OSS。请检查你的RAM角色和策略,确保"ecs.aliyuncs.com"被授予了扮演"AliyunECSImageImportDefaultRole"的权限。
404InvalidImagePipeline.NotFound%s-
404InvalidInstanceType.NotFoundThe specified instance type does not exist.指定的参数“InstanceType”不存在。
404InvalidVSwitchId.NotFoundThe specified VSwitchId does not exist.指定的VSwitchId不存在
404InvalidRegionId.NotFound%s提供的地域 ID 不存在。
404InvalidImage.NotFound%s.给定的镜像ID不存在。
404ImageComponent.NotFound%s.指定的镜像组件ID未找到。
404InvalidImagePipeline.BaseImageNotFoundThe BaseImage of the specified ImagePipeline is not found.指定模板的基础镜像没有找到。
404InvalidImagePipeline.OSSObjectNotFoundThe ImportImageOptions.DiskDeviceMappings.OSSObject of the specified ImagePipeline is not found in this region.指定的ImagePipeline的参数ImportImageOptions.DiskDeviceMappings.OSSObject在当前地域没有查询到。
500StartImagePipelineExecution.FailedStart image pipeline execution failed.执行镜像模版任务失败。

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

变更历史

变更时间变更内容概要操作
变更时间变更内容概要操作
2025-01-13OpenAPI 错误码发生变更查看变更详情
2024-12-19OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2024-11-07OpenAPI 错误码发生变更查看变更详情
2024-10-10OpenAPI 错误码发生变更查看变更详情
  • 本页导读 (1)
  • 接口说明
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 变更历史
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等