通过CancelOTATaskByJob取消指定批次下的设备升级作业_云市场(Marketplace)-阿里云帮助中心

CancelOTATaskByJob

取消指定批次下的设备升级作业。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CancelOTATaskByJob	系统规定参数。取值：CancelOTATaskByJob。
JobId	String	是	183634077921266****	升级批次ID。
CancelQueuedTask	Boolean	否	false	取消批次下所有状态为待推送（QUEUED）的设备升级作业。取值： true：取消。 false（默认）：不取消。
CancelNotifiedTask	Boolean	否	false	取消批次下所有状态为已推送（NOTIFIED）的设备升级作业。取值： true：取消。 false（默认）：不取消。
CancelUnconfirmedTask	Boolean	否	false	取消批次下所有状态为待确认（CONFIRM）的设备升级作业。取值： true：取消。 false：不取消。默认值为空。

重要

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

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
ErrorMessage	String	系统异常	调用失败时，返回的出错信息。
RequestId	String	291438BA-6E10-4C4C-B761-243B9A0D324F	物联网平台为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 true：调用成功，表示OTA升级包创建成功。 false：调用失败，表示OTA升级包创建失败。

示例

请求示例

curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=CancelOTATaskByJob&SignatureNonce=9e6189124f5a4716ad2de849467b****&AccessKeyId=xMr9wgwXQLhv5AUa65o0****&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T09%3A47%3A43Z&JobId=183634077921266****&CancelQueuedTask=true&CancelNotifiedTask=false&Signature=WJN0Ee8%2BX6pogcD3loLHIqQNEN0%3D'

正常返回示例

{
    "code": "",
    "requestId": "d2fce065-8238-4ee2-a793-0226f69b0542",
    "success": true
}