文档

CancelTask - 取消一件正在运行的任务

更新时间:

调用CancelTask取消一件正在运行的任务。目前,您能取消正在运行的导入镜像任务(ImportImage)和导出镜像任务(ExportImage)。

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
TaskIdstring

任务 ID。您可以调用 DescribeTasks 查看任务 ID 列表。

t-bp198jigq7l0h5ac****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterAn input parameter "RegionId" that is mandatory for processing the request is not supplied.-
400MissingParameterAn input parameter "TaskId" that is mandatory for processing the request is not supplied.-
400InvalidRegionId.NotFoundThe specified RegionId does not exist.指定的地域 ID 不存在。
400InvalidTaskId.NotFoundThe specified "TaskId" is not found.-
403InvalidTaskId.TaskActionNotSupportThe specified task action not support.不支持指定的任务操作。
403InvalidTaskId.IncorrectTaskStatusThe specified task status is invalid.指定的任务状态无效。
403CancelTaskFailedThe task is failed to cancel, Please contact the administrator.任务无法取消,请联系管理员。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈