文档

CancelAsyncTask - 取消异步任务

更新时间:

取消已提交,尚未执行完成的异步任务。

调试

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

授权信息

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

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

请求参数

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

业务空间唯一标识: AgentKey

c160c841c8e54295bf2f441432785944_p_efm
TaskIdstring

任务唯一 ID

3f7045e099474ba28ceca1b4eb6d6e21

返回参数

名称类型描述示例值
object

返回任务是否取消成功

Codestring

状态码

successful
Databoolean

业务数据

true
HttpStatusCodeinteger

http 状态码

200
Messagestring

错误说明

successful
RequestIdstring

请求唯一标识

FB698445-61DA-5361-BF73-1C5F1157E888
Successboolean

是否成功:true 成功,false 失败

True

示例

正常返回示例

JSON格式

{
  "Code": "successful",
  "Data": true,
  "HttpStatusCode": 200,
  "Message": "successful",
  "RequestId": "FB698445-61DA-5361-BF73-1C5F1157E888",
  "Success": true
}

错误码

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