QueryOTAJob - IoT Platform

使用說明

您可調用CreateOTAVerifyJob、CreateOTAStaticUpgradeJob或CreateOTADynamicUpgradeJob建立升級任務批次後，根據返回的JobId查看升級批次的詳情。

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryOTAJob	系統規定參數。取值：QueryOTAJob。
JobId	String	是	wahVIzGkCMuAUE2gDERM02****	升級批次ID。您調用CreateOTAVerifyJob、CreateOTAStaticUpgradeJob或CreateOTADynamicUpgradeJob建立升級任務批次後，返回的JobId。您也可以在物聯網平台控制台的升級包詳情頁面查看。
IotInstanceId	String	否	iot-cn-0pp1n8t****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回的升級批次資訊。詳情見以下Data所包含的參數。
DestVersion	String	1.0.1	升級目標版本號碼。
DownloadProtocol	String	HTTPS	升級包檔案的下載協議。
DynamicMode	Integer	1	動態升級模式。取值範圍： 1：除了升級當前滿足升級條件的裝置，還將持續檢查裝置是否滿足升級條件，對滿足升級條件的裝置進行升級。 2：僅對後續上報新版本號碼的裝置生效。僅升級策略為動態升級時，返回該參數。
FirmwareId	String	UfuxnwygsuSkVE0VCN****0100	升級包ID。
GrayPercent	String	50.00	灰階升級的比例。僅升級範圍為灰階升級時，返回該參數。
GroupId	String	CtjzCkNuOxUR***	分組升級的裝置分組ID。
GroupName	String	test	分組升級的裝置分組名稱。
JobDesc	String	batch upgrade	升級批次描述。
JobId	String	HvKuBpuk3rdk6E92CP****0200	升級批次ID，批次的唯一識別碼。
JobStatus	String	IN_PROGRESS	批次的狀態。 PLANNED：計劃中。批次已建立，但是定時時間未到。僅定時靜態升級的批次可能返回該值。 IN_PROGRESS：執行中。 COMPLETED：已完成。 CANCELED：已取消。
JobType	String	UPGRADE_FIRMWARE	批次類型。 VERIFY_FIRMWARE：升級包驗證批次。 UPGRADE_FIRMWARE：批量升級批次。
MaximumPerMinute	Integer	1000	每分鐘最多向多少個裝置推送升級包下載URL。
MultiModuleMode	Boolean	false	裝置是否支援多模組同時升級。 false（預設）：否，裝置不支援多模組同時升級。 true：是，裝置支援多模組同時升級。更多資訊，請參見裝置支援多模組同時升級說明表。
Name	String	Firmware2	升級包名稱。
NeedConfirm	Boolean	false	是否App確認升級。
NeedPush	Boolean	true	物聯網平台是否主動向裝置推送升級任務。
OverwriteMode	Integer	1	是否覆蓋之前的升級任務。取值： 1：不覆蓋。若裝置已有升級任務，則只執行已有任務。 2：覆蓋。裝置只執行新的升級任務。不覆蓋升級中的任務。
ProductKey	String	a19mzPZ****	升級包所屬產品的ProductKey。
RetryCount	Integer	1	裝置升級失敗後，自動重試次數。建立升級批次時，設定了失敗重試策略，則返回該參數。
RetryInterval	Integer	60	裝置升級失敗後，自動重試時間間隔，單位：分鐘。建立升級批次時，設定了失敗重試策略，則返回該參數。
SelectionType	String	STATIC	升級策略。 DYNAMIC：動態升級。調用CreateOTADynamicUpgradeJob建立的升級批次，該參數返回該值。 STATIC：靜態升級。調用CreateOTAStaticUpgradeJob建立的升級批次，該參數返回該值。
SrcVersions	List	{"SrcVersion": ["1.0.0"]}	待升級版本號碼列表。
Tags	Array of OtaTagDTO		升級批次標籤。
OtaTagDTO
Key	String	key1	標籤名。
Value	String	value1	標籤值。
TargetSelection	String	SPECIFIC	升級範圍。 ALL：全量升級。 SPECIFIC：定向升級。 GRAY：灰階升級。說明調用CreateOTADynamicUpgradeJob建立的動態升級批次，該參數僅返回ALL。
TimeoutInMinutes	Integer	5	裝置升級逾時時間，單位：分鐘。建立升級批次時，設定了逾時時間，則返回該參數。
UtcCreate	String	2019-12-28T02:43:10.000Z	批次建立時的時間，UTC格式。
UtcEndTime	String	2019-12-29T02:43:10.000Z	該批次任務執行結束時的時間，UTC格式。僅已執行結束的升級批次才返回此參數。
UtcModified	String	2019-12-28T02:43:10.000Z	批次最後一次修改時的時間，UTC格式。
UtcScheduleFinishTime	String	2019-12-30T02:43:10.000Z	定時升級結束的時間。僅定時升級任務且設定了定時升級結束時間時會返回該參數。
UtcScheduleTime	String	2019-12-29T02:43:10.000Z	定時升級發起的時間。僅定時升級任務會返回該參數。
UtcStartTime	String	2019-12-28T02:43:10.000Z	該批次任務開始執行時的時間，UTC格式。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	30F1BB8D-EDBF-44FD-BBC0-BE97DEA73991	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryOTAJob
&JobId=wahVIzGkCMuAUE2gDERM02****
&<公用請求參數>

正常返回樣本

XML格式

<QueryOTAJobResponse>
  <Data>
        <TimeoutInMinutes>5</TimeoutInMinutes>
        <JobDesc>batch upgrade</JobDesc>
        <DownloadProtocol>HTTPS</DownloadProtocol>
        <UtcStartTime>2019-12-28T02:43:10.000Z</UtcStartTime>
        <UtcEndTime>2019-12-29T02:43:10.000Z</UtcEndTime>
        <ProductKey>a19mzPZ****</ProductKey>
        <UtcModified>2019-12-28T02:43:10.000Z</UtcModified>
        <JobStatus>IN_PROGRESS</JobStatus>
        <UtcCreate>2019-12-28T02:43:10.000Z</UtcCreate>
        <SelectionType>STATIC</SelectionType>
        <TargetSelection>SPECIFIC</TargetSelection>
        <JobType>UPGRADE_FIRMWARE</JobType>
        <GroupId></GroupId>
        <GroupName></GroupName>
        <RetryInterval>60</RetryInterval>
        <RetryCount>1</RetryCount>
        <OverwriteMode>1</OverwriteMode>
        <MultiModuleMode>true</MultiModuleMode>
        <MaximumPerMinute>1000</MaximumPerMinute>
        <SrcVersions>
              <SrcVersion>1.0.0</SrcVersion>
        </SrcVersions>
        <Name>firmware2</Name>
        <NeedConfirm>true</NeedConfirm>
        <NeedPush>false</NeedPush>
        <FirmwareId>UfuxnwygsuSkVE0VCN****0100</FirmwareId>
        <JobId>HvKuBpuk3rdk6E92CP****0200</JobId>
        <DestVersion>1.0.1</DestVersion>
  </Data>
  <RequestId>30F1BB8D-EDBF-44FD-BBC0-BE97DEA73991</RequestId>
  <Success>true</Success>
</QueryOTAJobResponse>

JSON格式

{
  "Data": {
    "TimeoutInMinutes": 5,
    "JobDesc": "batch upgrade",
    "DownloadProtocol":"HTTPS",
    "UtcStartTime": "2019-12-28T02:43:10.000Z",
    "UtcEndTime": "2019-12-29T02:43:10.000Z",
    "ProductKey": "a19mzPZ****",
    "UtcModified": "2019-12-28T02:43:10.000Z",
    "JobStatus": "IN_PROGRESS",
    "UtcCreate": "2019-12-28T02:43:10.000Z",
    "SelectionType": "STATIC",
    "TargetSelection": "SPECIFIC",
    "JobType": "UPGRADE_FIRMWARE",
    "GroupId":"",
    "GroupName":"",
    "RetryInterval":60,
    "RetryCount":1,
    "OverwriteMode":1,
    "MultiModuleMode":true,
    "MaximumPerMinute":1000,
    "SrcVersions": {
      "SrcVersion": ["1.0.0"]
    },
    "Name":"firmware2",
    "NeedConfirm":true,
    "NeedPush":false,
    "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
    "JobId": "HvKuBpuk3rdk6E92CP****0200",
    "DestVersion": "1.0.1"
  },
  "RequestId": "30F1BB8D-EDBF-44FD-BBC0-BE97DEA73991",
  "Success": true
}

錯誤碼

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