Cancels the pending device update tasks of a firmware component.
Limits
- This operation can cancel only the pending update tasks.
-
Each Alibaba Cloud account can run a maximum of 10 queries per second (QPS).Note RAM users of an Alibaba Cloud account share the quota of the account.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CancelOTATaskByDevice |
The operation that you want to perform. Set the value to CancelOTATaskByDevice. |
DeviceName.N | RepeatList | Yes | device1 |
The list of device names that you want to query. Device names must be unique. The list can contain up to 200 device names. |
FirmwareId | String | Yes | T0F5b5tpFnHQrgfk****030100 |
The ID of the firmware. A firmware ID is returned when you call the CreateOTAFirmware operation to create the firmware. You can call the ListOTAFirmware operation and view the firmware ID in the response. |
ProductKey | String | Yes | a1V4kde**** |
The ProductKey of the product to which the device belongs. |
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. |
JobId | String | No | wahVIzGkCMuAUE2gDERM02**** |
The ID of the update batch. If you specify this parameter, only the device update tasks in the specified batch are deleted. After you call the CreateOTAVerifyJob, CreateOTAStaticUpgradeJob, or CreateOTADynamicUpgradeJob operation to create an update task, you can obtain the JobId parameter. You can also view the batch ID on the Firmware Details page of the IoT Platform console. |
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this API 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 | A01829CE-75A1-4920-B775-921146A1AB79 |
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=CancelOTATaskByDevice
&FirmwareId=T0F5b5tpFnHQrgfk****030100
&ProductKey=a1V4kde****
&DeviceName.1=deviceName1
&DeviceName.2=deviceName2
&<Common request parameters>
Sample success responses
XML
format
<CancelOTATaskByDeviceResponse>
<RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
<Success>true</Success>
</CancelOTATaskByDeviceResponse>
JSON
format
{
"RequestId": "A01829CE-75A1-4920-B775-921146A1AB79",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.