CancelOTATaskByDevice

更新时间：2025-10-10 06:57:47下载pdf

取消指定OTA升级包下状态为待确认、待推送、已推送状态的设备升级作业。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CancelOTATaskByDevice	系统规定参数。取值：CancelOTATaskByDevice。
ProductKey	String	是	k1nhvyl****	要取消升级的设备所属产品的ProductKey。
FirmwareId	String	是	167	OTA升级包ID，OTA升级包的唯一标识符。
DeviceName.N	RepeatList	是	device1	要取消升级的设备名称。
JobId	String	否	183634077921266****	升级批次ID。传入此参数则只取消指定批次下的设备升级任务。

注意：调用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-d6e******48958054.tuyacloud.com:8686/?Action=CancelOTATaskByDevice&SignatureNonce=9e6189124f5a4716ad2de849467b****&AccessKeyId=xMr9wgwXQLhv5AUa65o0****&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T09%3A47%3A43Z&FirmwareId=168&ProductKey=k1nhvyl****&DeviceName.1=testDevice1&DeviceName.2=testDevice2&Signature=WJN0Ee8%2BX6pogcD3loLHIqQNEN0%3D'

正常返回示例

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

上一篇CancelOTATaskByJob

下一篇ConfirmOTATask