CancelTask - 取消任务

通过此接口取消指定异步任务。

接口说明

仅状态为 Pending 或 Running 的 Task 可以被取消。

调用 CancelTask 可以取消 Cloud Control API 执行的任务,但是不会终止已经在下游云产品服务上启动的任务。

调试

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

授权信息

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

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

请求语法

PUT /api/v1/tasks/{taskId}/operation/cancel HTTP/1.1

请求参数

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

任务 id。

task-433aead756057fff2913e7ce5****

返回参数

名称类型描述示例值
object

返回结构。

requestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

示例

正常返回示例

JSON格式

{
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-04API 内部配置变更,不影响调用查看变更详情