Cancels update tasks of a specified batch.
Limits
Each Alibaba Cloud account can run a maximum of 5 queries per second (QPS).
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CancelOTATaskByJob |
The operation that you want to perform. Set the value to CancelOTATaskByJob. |
JobId | String | Yes | 7glPHmaDYLAYMD1HHutT02**** |
The ID of the update batch. After you call the CreateOTAStaticUpgradeJob or CreateOTADynamicUpgradeJob operation to create an update batch, the JobId parameter is returned. You can also view the batch ID on the Firmware Details page of the IoT Platform console. |
IotInstanceId | String | No | iot_instc_pu****_c*-v64******** |
The ID of the instance. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased. |
CancelScheduledTask | Boolean | No | false |
Specifies whether to cancel update tasks of a scheduled update batch. If you specify the ScheduleTime parameter when you call the CreateOTAStaticUpgradeJob operation, a scheduled update batch is created. Valid values:
Default value: false |
CancelQueuedTask | Boolean | No | false |
Specifies whether to cancel the update tasks that is in the QUEUED state in an update batch. Valid values:
Default value: false |
CancelInProgressTask | Boolean | No | false |
Specifies whether to cancel the update tasks that is in the IN_PROGRESS state in an update batch. Valid values:
Default value: false |
CancelNotifiedTask | Boolean | No | false |
Specifies whether to cancel the update tasks that is in the NOTIFIED state in an update batch. Valid values:
Default value: false |
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information about common request parameters, see Common request parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | iot.system.SystemException |
The error code returned if the call fails. For more information, see Error codes. |
ErrorMessage | String | A system exception occurred. |
The error message returned if the call fails. |
RequestId | String | 291438BA-6E10-4C4C-B761-243B9A0D324F |
The globally unique identifier that Alibaba Cloud generated for the request. |
Success | Boolean | true |
Indicates whether the call was successful.
|
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=CancelOTATaskByJob
&JobId=7glPHmaDYLAYMD1HHutT02****
&CancelScheduledTask=false
&CancelQueuedTask=true
&CancelNotifiedTask=false
&CancelInProgressTask=false
&<Common request parameters>
Sample success responses
XML
format
<CancelOTATaskByJobResponse>
<RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
<Success>true</Success>
</CancelOTATaskByJobResponse>
JSON
format
{
"RequestId": "291438BA-6E10-4C4C-B761-243B9A0D324F",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.