全部产品
Search

搜索本产品

    云服务器 ECS：StartImagePipelineExecution - 通过一个镜像模板执行构建镜像的任务

    文档中心

    云服务器 ECS：StartImagePipelineExecution - 通过一个镜像模板执行构建镜像的任务

    更新时间：Nov 14, 2024

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

    接口说明

    • 镜像模板创建好之后，需要通过该接口执行构建镜像的任务，系统将根据镜像模板设置好的参数进行构建、分发、共享镜像。
    • 同一个镜像模板，同一时间只能执行一个构建镜像任务。取消构建镜像任务（CancelImagePipelineExecution）可同时执行多次，并且取消构建镜像任务和构建镜像任务之间互不干扰。

    调试

    您可以在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
    TemplateTagarray<object>否
    说明 该参数已废弃。
    object否
    Keystring否
    说明 该参数已废弃。
    		null
    Valuestring否
    说明 该参数已废弃。
    		null
    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错误码错误信息描述
    400InvalidImage.OsTypeUnsupportedThe specified base image does not support image building.指定的基础镜像操作系统不支持进行镜像构建。
    400InvalidParameter.BuildContent%s.构建模板内容无效。
    400InvalidParameter.TestContent%s.测试模板的内容无效。
    400InvalidImageComponent.NotSupported%s.指定的镜像组件不可用。
    403InvalidImagePipeline.HasRunningExecution%s-
    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.指定模板的基础镜像没有找到。
    500StartImagePipelineExecution.FailedStart image pipeline execution failed.执行镜像模版任务失败。

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

    变更历史

    变更时间变更内容概要操作
    2024-11-07OpenAPI 错误码发生变更查看变更详情
    2024-10-10OpenAPI 错误码发生变更查看变更详情