调用StartImagePipelineExecution通过一个镜像模板执行构建镜像的任务。
接口说明
- 镜像模板创建好之后，需要通过该接口执行构建镜像的任务，系统将根据镜像模板设置好的参数进行构建、分发、共享镜像。
- 同一个镜像模板，同一时间只能执行一个构建镜像任务。取消构建镜像任务（CancelImagePipelineExecution）可同时执行多次，并且取消构建镜像任务和构建镜像任务之间互不干扰。
- 执行镜像构建模板时，需要创建多台中转实例辅助构建镜像，中转实例为按量计费的 ECS 实例，将收取一定的费用。更多信息，请参见按量付费。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:StartImagePipelineExecution | update | *ImagePipeline acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
TemplateTagdeprecated | array<object> | 否 | 说明
该参数已废弃。
| |
| object | 否 | |||
| Key | string | 否 | 说明
该参数已废弃。
| null |
| Value | string | 否 | 说明
该参数已废弃。
| null |
| Tag | array<object> | 否 | 标签列表。 | |
| object | 否 | 标签对象。 | ||
| Key | string | 否 | 标签键。N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以 | TestKey |
| Value | string | 否 | 资源的标签值。N 的取值范围：1~20。一旦传入该值，可以为空字符串。最多支持 128 个字符，不能以 | TestValue |
| ImagePipelineId | string | 是 | 镜像模板 ID。 | ip-2ze5tsl5bp6nf2b3**** |
| ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多详情，请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
返回参数
示例
正常返回示例
JSON格式
{
"ExecutionId": "exec-5fb8facb8ed7427c****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidImage.OsTypeUnsupported | The specified base image does not support image building. | 指定的基础镜像操作系统不支持进行镜像构建。 |
| 400 | InvalidParameter.BuildContent | %s. | 构建模板内容无效。 |
| 400 | InvalidParameter.TestContent | %s. | 测试模板的内容无效。 |
| 400 | InvalidImageComponent.NotSupported | %s. | 指定的镜像组件不可用。 |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | 标签中存在重复的键，请保持键的唯一性。 |
| 400 | InvalidTagKey.Malformed | The 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://”。 |
| 400 | InvalidTagValue.Malformed | The specified Tag.N.Value is not valid. Tag values support up to 128 characters, and cannot contain "http://" or "https://". | 指定的标签值无效。标签值最多支持 128 个字符，并且不能包含“http://”或“https://”。 |
| 403 | InvalidImagePipeline.HasRunningExecution | %s | - |
| 404 | InvalidImagePipeline.NotFound | %s | - |
| 404 | InvalidInstanceType.NotFound | The specified instance type does not exist. | 指定的参数“InstanceType”不存在。 |
| 404 | InvalidVSwitchId.NotFound | The specified VSwitchId does not exist. | 指定的VSwitchId不存在 |
| 404 | InvalidRegionId.NotFound | %s | 提供的地域 ID 不存在。 |
| 404 | InvalidImage.NotFound | %s. | 给定的镜像ID不存在。 |
| 404 | ImageComponent.NotFound | %s. | 指定的镜像组件ID未找到。 |
| 404 | InvalidImagePipeline.BaseImageNotFound | The BaseImage of the specified ImagePipeline is not found. | 指定模板的基础镜像没有找到。 |
| 500 | StartImagePipelineExecution.Failed | Start image pipeline execution failed. | 执行镜像模版任务失败。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-19 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-11-07 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-10-10 | OpenAPI 错误码发生变更 | 查看变更详情 |