Cancels the pending device update tasks for specified firmware.

Limits

  • This operation can only cancel the update tasks of devices that are pending an update.
  • The maximum number of queries per second (QPS) for a single Alibaba Cloud account to call this operation is 5. The quota is shared between the Alibaba Cloud account and RAM users.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to CancelOTATaskByDevice.
FirmwareId String Yes The firmware ID. It is the unique identifier of the firmware.

The firmware ID is a response parameter that is returned by the CreateOTAFirmware operation.

You can call the ListOTAFirmware operation to view the firmware ID.

ProductKey String Yes The key of the product to which the device belongs.
DeviceNames List<String> Yes The list of device names for which you want to cancel the update tasks.
  • The list cannot contain duplicate device names.
  • The list can contain up to 200 device names.
IotInstanceId String No The ID of your IoT Platform instance. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased.
Common request parameters N/A Yes For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Description
RequestId String The globally unique ID that is generated by Alibaba Cloud for the request.
Success Boolean Indicates whether the call is successful. true indicates that the call was successful. false indicates that the call failed.
ErrorMessage String The error message returned if the call fails.
Code String The error code returned if the call fails. For information about error codes, see Error codes.

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

  • JSON format
    {
      "RequestId": "A01829CE-75A1-4920-B775-921146A1AB79",
      "Success": true
    }
  • XML format
    <? xml version="1.0" encoding="utf-8"? >
    <CancelOTATaskByDeviceResponse>
      <RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
      <Success>true</Success>
    </CancelOTATaskByDeviceResponse>