CreateOTAVerifyJob - IoT Platform

使用說明

將OTA升級包推送給裝置批量升級前，必須完成OTA升級包驗證。只有已驗證的OTA升級包才可用於批量裝置升級。您可以調用QueryOTAFirmware查看OTA升級包驗證狀態。
不能對驗證進行中或驗證已成功的OTA升級包重複發起驗證任務。
最多隻能傳入10個裝置用於OTA升級包驗證。

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	CreateOTAVerifyJob	系統規定參數。取值：CreateOTAVerifyJob。
FirmwareId	String	是	nx3xxVvFdwvn6dim50PY03****	OTA升級包ID，升級包的唯一識別碼。 FirmwareId是調用CreateOTAFirmware建立OTA升級包時，返回的參數之一。您也可以調用ListOTAFirmware介面，從返回參數中查看。
ProductKey	String	是	a1VJwBw****	OTA升級包所屬產品的ProductKey。
Tag.N.Key	String	是	key1	批次標籤key。僅支援英文字母、數字、半形句號（.），長度限制為1~30個字元。支援最多添加10個批次標籤。批次標籤將在向裝置推送升級通知時下發給裝置。說明批次標籤可以不傳入。是否必選的是，表示如果傳入批次標籤Tag，Tag.N.Value與Tag.N.Key必須成對傳入。
Tag.N.Value	String	是	value1	批次標籤value。長度限制為1~1024個字元。支援最多添加10個批次標籤。所有批次標籤key和value的長度總和，不能超過4096個字元。說明批次標籤可以不傳入。是否必選的是，表示如果傳入批次標籤Tag，Tag.N.Value與Tag.N.Key必須成對傳入。
TargetDeviceName.N	RepeatList	是	testdevice	待驗證的裝置。說明裝置所屬產品必須與OTA升級包所屬產品一致。裝置名稱不能重複。最多可傳入10個裝置名稱。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
TimeoutInMinutes	Integer	否	1440	設定裝置升級逾時時間，單位分鐘，範圍1~1,440。
NeedPush	Boolean	否	true	物聯網平台是否主動向裝置推送升級任務。 true（預設）：是。批次任務建立完成後，物聯網平台主動將升級任務，直接推送給升級範圍內的線上裝置。此時，裝置仍可主動向物聯網平台發起請求，來擷取OTA升級任務資訊。 false：否。裝置必須通過向物聯網平台發起請求，來擷取OTA升級任務資訊。
NeedConfirm	Boolean	否	false	如需自主控制裝置OTA升級時，可配置此參數，通過手機App來控制，裝置是否可進行OTA升級。手機App需您自行開發。 false（預設）：否。直接按照NeedPush設定，擷取OTA升級任務資訊。 true：是。裝置無法擷取OTA升級任務，需App側確認OTA升級後，才能按照NeedPush設定，擷取OTA升級任務資訊。
DownloadProtocol	String	否	HTTPS	升級包下載協議，可選：HTTPS（預設）或MQTT。裝置端收到物聯網平台推送的升級包下載資訊後，通過該協議下載升級包。重要使用HTTP協議下載升級包，檔案大小不能超過1,000 MB，且僅支援`.bin`、`.dav`、`.tar`、`.gz`、`.zip`、`.gzip`、`.apk`、`.tar.gz`、`.tar.xz`、`.pack`格式的檔案。更多限制說明，請參見OTA升級概述。使用MQTT協議下載升級包，必須符合以下條件：支援的地區：僅中國的華東2（上海）、華北2（北京）和華南1（深圳）。 OTA升級包：僅包含一個檔案，且檔案大小不超過16 MB。裝置端SDK：必須使用物聯網平台提供的C語言Link SDK最新版本的軟體包，開發OTA升級和MQTT下載檔案的能力。詳細內容，請參見使用MQTT協議下載升級包的OTA升級程式碼範例。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回的驗證批次資訊。詳情見以下參數。
JobId	String	wahVIzGkCMuAUE2gDERM02****	OTA升級包驗證任務ID，即用於驗證OTA升級包的裝置升級批次ID。
UtcCreate	String	2019-11-04T06:22:19.566Z	OTA升級包驗證任務的建立時間，UTC格式。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateOTAVerifyJob
&FirmwareId=nx3xxVvFdwvn6dim50PY03****
&ProductKey=a1VJwBw****
&Tag.1.Key=key1
&Tag.1.Value=value1
&TargetDeviceName.1=testdevice
&TimeoutInMinutes=1440
&<公用請求參數>

正常返回樣本

XML格式

<CreateOTAVerifyJobResponse>
   <Data>
       <JobId>wahVIzGkCMuAUE2gDERM02****</JobId>
       <UtcCreate>2019-11-04T06:22:19.566Z</UtcCreate>
   </Data>
   <RequestId>29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1</RequestId>
   <Success>true</Success>
</CreateOTAVerifyJobResponse>

JSON格式

{
  "Data": {
    "JobId": "wahVIzGkCMuAUE2gDERM02****",
    "UtcCreate": "2019-11-04T06:22:19.566Z"
  },
  "RequestId": "29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1",
  "Success": true
}

錯誤碼

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