CancelOTATaskByJob

Last Updated on : 2025-10-10 06:57:37Copy for LLMView as MarkdownDownload PDF

Cancels the device upgrade job in the specified batch.

Request Parameters

Name	Type	Required	Sample Values	Description
Action	String	Yes	CancelOTATaskByJob	System defined parameters. Value: CancelOTATaskByJob.
JobID	String	Yes	183634077921266 * * * *	The upgrade batch ID.
CancelQueuedTask	Boolean	No	False	Cancel all statuses under the batch to be pushed ( QUEUED ) of the equipment upgrade job. Value: ●True : Cancelled. ●False(Default): Do not cancel.
CancelNotifiedTask	Boolean	No	False	All statuses under the canceled batch are pushed ( NOTIFIED ) of the equipment upgrade job. Value: ●True : Cancelled. ●False (Default): Do not cancel.
CancelUnconfirmedTask	Boolean	No	False	All statuses under the canceled batch are to be confirmed ( CONFIRM ) of the equipment upgrade job. Value: ●True : Cancelled. ●False : Not canceled. The default value is empty.

Note: When calling an API, in addition to the API-specific request parameters described in this topic, you must also pass in the common request parameters. For more information about common request parameters, see Common parameters.

Return Data

Name	Type	Sample Values	Description
Code	String	Iot.system.SystemException	The error code returned when the call fails. For more information, see Error codes.
ErrorMessage	String	System Exception	Error information returned when the call fails.
RequestID	String	Kan	The unique identifier that IoT Platform generates for the request.
Success	Boolean	True	Whether the call was successful. ●True : The call is successful, indicating that the OTA upgrade package is successfully created. ●False : The call fails, indicating that the OTA upgrade package failed to be created.

Example

Request Example

curl 'https://si-d6e******958054.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'

Normal Return Example

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

Prev DocQueryOTAJob

Next DocCancelOTATaskByDevice