调用该接口取消任务的执行。

使用说明

取消任务过程中，任务处于CANCELLING状态。如果对该状态任务，重复调用CancelJob，系统直接返回失败。

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为5。

说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CancelJob

系统规定参数。取值：CancelJob。
JobId String 是 XUbmsMHmkqv0PiAG****010001

任务ID。任务的全局唯一标识符。
IotInstanceId String 否 iot-cn-0pp1n8t****

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无ID值，则无需传入。

实例的更多信息，请参见实例概述。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时，返回的错误码。更多信息，请参见错误码。

ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String C25255EA-9F6E-4E04-85FE-AC1E9C136EBB

阿里云为该请求生成的唯一标识符。
Success Boolean true

表示是否调用成功。

  • true：调用成功。
  • false：调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CancelJob
&JobId=XUbmsMHmkqv0PiAG****010001
&<公共请求参数>

正常返回示例

XML格式 

<CancelJobResponse>
  <RequestId>C25255EA-9F6E-4E04-85FE-AC1E9C136EBB</RequestId>
  <Success>true</Success>
</CancelJobResponse>

JSON格式 

{
    "RequestId": "C25255EA-9F6E-4E04-85FE-AC1E9C136EBB",
    "Success": true
}

错误码

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