Cancels update tasks of a specified batch.

Limits

Each Alibaba Cloud account can run a maximum of 5 queries per second (QPS).

Note RAM users of an Alibaba Cloud account share the quota of the account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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. You can view the instance ID on the Overview page in the IoT Platform console.

Notice
  • If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
  • If your instance has no Overview page or ID, you do not need to set this parameter.

For more information, see Overview.

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:

  • true: cancel update tasks of a scheduled update batch.
  • false: does not cancel update tasks of a scheduled update batch.

Default value: false.

CancelQueuedTask Boolean No false

Specifies whether to cancel the update tasks that are in the QUEUED state in an update batch. Valid values:

  • true: cancels the update tasks that are in the QUEUED state.
  • false: does not cancel the update tasks that are in the QUEUED state.

Default value: false.

Notice If you set this parameter to true and specify the CancelUnconfirmedTask parameter, only the update tasks that are in the QUEUED state are canceled. If you do not specify the CancelUnconfirmedTask parameter, the update tasks that are in the QUEUED or CONFIRM state are canceled.
CancelInProgressTask Boolean No false

Specifies whether to cancel the update tasks that are in the IN_PROGRESS state in an update batch. Valid values:

  • true: cancels the update tasks that are in the IN_PROGRESS state.
  • false: does not cancel the update tasks that are in the NOTIFIED state.

Default value: false.

CancelNotifiedTask Boolean No false

Specifies whether to cancel the update tasks that are in the NOTIFIED state in an update batch. Valid values:

  • true: cancels the update tasks that are in the NOTIFIED state.
  • false: does not cancel the update tasks that are in the NOTIFIED state.

Default value: false.

CancelUnconfirmedTask Boolean No false

Specifies whether to cancel the update tasks that are in the CONFIRM state in an update batch. Valid values:

  • true: cancels the update tasks that are in the CONFIRM state.
  • false: does not cancel the update tasks that are in the CONFIRM state.

By default, this parameter is left empty.

Notice If you do not specify this parameter and set the CancelQueuedTask parameter to true, the update tasks that are in the CONFIRM state are canceled. If you set the CancelQueuedTask parameter to false, the update tasks that are in the CONFIRM state are not canceled.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, 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 ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.

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.