調用該介面取消指定OTA升級包下狀態為待確認、待推送、已推送、升級中狀態的裝置升級作業。
使用說明
該介面只能取消待確認、待推送、已推送、升級中狀態的裝置升級。
QPS限制
單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為10。
說明 單個阿里雲帳號下的所有RAM使用者共用該阿里雲帳號的配額。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| Action | String | 是 | CancelOTATaskByDevice | 系統規定參數。取值：CancelOTATaskByDevice。 |
| ProductKey | String | 是 | a1V4kde**** | 要取消升級的裝置所屬產品的ProductKey。 |
| FirmwareId | String | 是 | T0F5b5tpFnHQrgfk****030100 | OTA升級包ID，OTA升級包的唯一識別碼。 OTA升級包ID是調用CreateOTAFirmware建立OTA升級包時，返回的參數之一。 可以調用ListOTAFirmware，從返回參數中查看。 |
| DeviceName.N | RepeatList | 是 | device1 | 要取消升級的裝置名稱。 裝置名稱不能重複。 最多可傳入200個裝置名稱。 |
| JobId | String | 否 | wahVIzGkCMuAUE2gDERM02**** | 升級批次ID。傳入此參數則只取消指定批次下的裝置升級任務。 批次ID是您調用CreateOTAVerifyJob、CreateOTAStaticUpgradeJob或CreateOTADynamicUpgradeJob建立升級任務後返回的JobId。 您也可以在物聯網平台控制台上OTA升級包詳情頁面查看。 |
| IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。 重要
執行個體的更多資訊，請參見執行個體概述。 |
調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。
返回資料
| 名稱 | 類型 | 樣本值 | 描述 |
| Code | String | iot.system.SystemException | 調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。 |
| ErrorMessage | String | 系統異常 | 調用失敗時，返回的出錯資訊。 |
| RequestId | String | A01829CE-75A1-4920-B775-921146A1AB79 | 阿里雲為該請求產生的唯一識別碼。 |
| Success | Boolean | true | 是否調用成功。
|
樣本
請求樣本
https://iot.cn-shanghai.aliyuncs.com/?Action=CancelOTATaskByDevice
&FirmwareId=T0F5b5tpFnHQrgfk****030100
&ProductKey=a1V4kde****
&DeviceName.1=deviceName1
&DeviceName.2=deviceName2
&<公用請求參數>正常返回樣本
XML格式
<CancelOTATaskByDeviceResponse>
<RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
<Success>true</Success>
</CancelOTATaskByDeviceResponse>JSON格式
{
"RequestId": "A01829CE-75A1-4920-B775-921146A1AB79",
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。