CancelOTATaskByJob - IoT Platform

使用說明

調用本介面時，除必傳參數JobId，還需對照非必選參數，傳入待取消升級作業對應的類型或狀態，否則調用介面會失敗。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為5。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	CancelOTATaskByJob	系統規定參數。取值：CancelOTATaskByJob。
JobId	String	是	7glPHmaDYLAYMD1HHutT02****	升級批次ID。您調用CreateOTAStaticUpgradeJob或CreateOTADynamicUpgradeJob建立批次返回的JobId。您也可以在物聯網平台控制台韌體的韌體詳情頁查看。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
CancelScheduledTask	Boolean	否	false	取消定時升級批次下的裝置升級作業，即調用CreateOTAStaticUpgradeJob時，傳入了ScheduleTime參數建立的升級批次。取值： true：取消。 false（預設）：不取消。
CancelQueuedTask	Boolean	否	false	取消批次下所有狀態為待推送（QUEUED）的裝置升級作業。取值： true：取消。 false（預設）：不取消。重要該參數值為true時，如果傳入CancelUnconfirmedTask參數值，則僅取消待推送狀態的裝置升級作業；如果不傳入CancelUnconfirmedTask參數值，則會取消待確認和待推送狀態的裝置升級任務。
CancelInProgressTask	Boolean	否	false	取消批次下所有狀態為升級中（IN_PROGRESS）的裝置升級作業。取值： true：取消。 false（預設）：不取消。
CancelNotifiedTask	Boolean	否	false	取消批次下所有狀態為已推送（NOTIFIED）的裝置升級作業。取值： true：取消。 false（預設）：不取消。
CancelUnconfirmedTask	Boolean	否	false	取消批次下所有狀態為待確認（CONFIRM）的裝置升級作業。取值： true：取消。 false：不取消。預設值為空白。重要如果不傳入此參數，當CancelQueuedTask值為true時，會同步取消待確認狀態的裝置升級任務；當CancelQueuedTask值為false時，不會取消待確認狀態的裝置升級作業。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	291438BA-6E10-4C4C-B761-243B9A0D324F	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=CancelOTATaskByJob
&JobId=7glPHmaDYLAYMD1HHutT02****
&CancelScheduledTask=false
&CancelQueuedTask=true
&CancelNotifiedTask=false
&CancelInProgressTask=false
&<公用請求參數>

正常返回樣本

XML格式

<CancelOTATaskByJobResponse>
    <RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
    <Success>true</Success>
</CancelOTATaskByJobResponse>

JSON格式

{
  "RequestId": "291438BA-6E10-4C4C-B761-243B9A0D324F",
  "Success": true
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。