调用CancelImagePipelineExecution取消一个镜像构建任务。
接口说明
调用该接口前,请确认需要取消的镜像构建任务处于构建中(BUILDING)、分发中(DISTRIBUTING)或资源回收中(RELEASING)的状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:CancelImagePipelineExecution | update | *ImagePipeline acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
TemplateTag | array<object> | 否 | 说明
该参数暂未开放使用。
| |
object | 否 | 说明
该参数暂未开放使用。
| ||
Key | string | 否 | 说明
该参数暂未开放使用。
| null |
Value | string | 否 | 说明
该参数暂未开放使用。
| null |
ExecutionId | string | 是 | 构建任务 ID。 | exec-5fb8facb8ed7427c**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | InvalidStatus.CancelFailed | Failed to cancel execution,status is success, failed or cancelled. |
403 | InvalidStatus.ImagePipelineExecution | %s |
404 | InvalidImagePipelineExecution.NotFound | The specified image pipeline execution does not exist! |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2021-06-17 | OpenAPI 错误码发生变更 | 查看变更详情 |