调用该接口取消指定批次下的设备升级作业。

使用说明

调用本接口时，除必传参数JobId，还需对照非必选参数，传入待取消升级作业对应的类型或状态，否则调用接口会失败。

QPS限制

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

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

调试

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

请求参数

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

系统规定参数。取值：CancelOTATaskByJob。
JobId String 是 7glPHmaDYLAYMD1HHutT02****

升级批次ID。

您调用CreateOTAStaticUpgradeJob或CreateOTADynamicUpgradeJob创建批次返回的JobId。您也可以在物联网平台控制台固件的固件详情页查看。

IotInstanceId String 否 iot_instc_pu****_c*-v64********

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

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无实例概览页面或ID值，则无需传入。

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

CancelScheduledTask Boolean 否 false

取消定时升级批次下的设备升级作业，即调用CreateOTAStaticUpgradeJob时，传入了ScheduleTime参数创建的升级批次。取值：

  • true：取消。
  • false（默认）：不取消。
CancelQueuedTask Boolean 否 false

取消批次下所有状态为待推送（QUEUED）的设备升级作业。取值：

  • true：取消。
  • false（默认）：不取消。
重要 该参数值为true时，如果传入CancelUnconfirmedTask参数值，则仅取消待推送状态的设备升级作业；如果不传入CancelUnconfirmedTask参数值，则会取消待确认和待推送状态的设备升级任务。
CancelInProgressTask Boolean 否 false

取消批次下所有状态为升级中（IN_PROGRESS）的设备升级作业。取值：

  • true：取消。
  • false（默认）：不取消。
CancelNotifiedTask Boolean 否 false

取消批次下所有状态为已推送（NOTIFIED）的设备升级作业。取值：

  • true：取消。
  • false（默认）：不取消。
CancelUnconfirmedTask Boolean 否 false

取消批次下所有状态为待确认（CONFIRM）的设备升级作业。取值：

  • true：取消。
  • false：不取消。

默认值为空。

重要 如果不传入此参数，当CancelQueuedTask值为true时，会同步取消待确认状态的设备升级任务；当CancelQueuedTask值为false时，不会取消待确认状态的设备升级作业。

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

返回数据

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

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

ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String 291438BA-6E10-4C4C-B761-243B9A0D324F

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

表示是否调用成功。

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

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=CancelOTATaskByJob
&JobId=7glPHmaDYLAYMD1HHutT02****
&CancelScheduledTask=false
&CancelQueuedTask=true
&CancelNotifiedTask=false
&CancelInProgressTask=false
&<公共请求参数>

正常返回示例

XML格式 

<CancelOTATaskByJobResponse>
    <RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
    <Success>true</Success>
</CancelOTATaskByJobResponse>

JSON格式 

{
  "RequestId": "291438BA-6E10-4C4C-B761-243B9A0D324F",
  "Success": true
}

错误码

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