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

限制说明

  • 如果在企业版实例中调用该接口,请求参数IotInstanceId必须填写。否则,调用接口会失败。
  • 单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为5。
说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

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

系统规定参数。取值:CancelOTATaskByJob。

JobId String 7glPHmaDYLAYMD1HHutT02****

升级批次ID。

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

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

实例ID。

  • 企业版实例:必须传入此参数。您可在物联网平台控制台的实例概览页面,查看您的企业版实例ID。
  • 公共实例:无需传入此参数。
CancelScheduledTask Boolean false

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

  • true:取消。
  • false:不取消。

不传入此参数,则取默认值false。

CancelQueuedTask Boolean false

取消批次下所有状态为待推送(QUEUED)的设备升级作业。取值:

  • true:取消。
  • false:不取消。

不传入此参数,则取默认值false

注意 该参数值为 true时,如果传入 CancelUnconfirmedTask参数值,则仅取消待推送状态的设备升级作业;如果不传入 CancelUnconfirmedTask参数值,则会取消待确认和待推送状态的设备升级任务。
CancelInProgressTask Boolean false

取消批次下所有状态为升级中(IN_PROGRESS)的设备升级作业。取值:

  • true:取消。
  • false:不取消。

不传入此参数,则取默认值false

CancelNotifiedTask Boolean false

取消批次下所有状态为已推送(NOTIFIED)的设备升级作业。取值:

  • true:取消。
  • false:不取消。

不传入此参数,则取默认值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
}