ListOTAJobByFirmware - IoT Platform

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ListOTAJobByFirmware	系統規定參數。取值：ListOTAJobByFirmware。
CurrentPage	Integer	是	1	指定從返回結果中的第幾頁開始顯示。頁數從1開始排序。
FirmwareId	String	是	FJFx8JzpnhpIsKftRjjm03****	升級包ID，升級包的唯一識別碼。升級包ID是調用CreateOTAFirmware建立升級包時，返回的參數之一。可以調用ListOTAFirmware，從返回參數中查看。
PageSize	Integer	是	10	指定返回結果中，每頁顯示的升級批次數量。最大值200。
IotInstanceId	String	否	iot-cn-0pp1n8t****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
CurrentPage	Integer	1	當前頁碼。
Data	Array of SimpleOTAJobInfo		調用成功時，返回的批次資訊。詳情請參見SimpleOTAJobInfo下的參數。
SimpleOTAJobInfo
FirmwareId	String	UfuxnwygsuSkVE0VCN****0100	升級包ID。
JobId	String	HvKuBpuk3rdk6E92CP****0200	升級批次ID，批次的唯一識別碼。
JobStatus	String	IN_PROGRESS	批次的狀態。 PLANNED：計劃中。批次已建立，但是定時時間未到。僅定時靜態升級的批次可能返回該值。 IN_PROGRESS：執行中。 COMPLETED：已完成。 CANCELED：已取消。
JobType	String	UPGRADE_FIRMWARE	批次類型。 VERIFY_FIRMWARE：升級包驗證批次。 UPGRADE_FIRMWARE：批量升級批次。
ProductKey	String	a19mzPZ****	升級包所屬產品的唯一標識。
SelectionType	String	STATIC	升級策略。 DYNAMIC：動態升級。調用CreateOTADynamicUpgradeJob建立的升級批次，該參數返回該值。 STATIC：靜態升級。調用CreateOTAStaticUpgradeJob建立的升級批次，該參數返回該值。
Tags	Array of OtaTagDTO		升級批次標籤。
OtaTagDTO
Key	String	key1	標籤名。
Value	String	value1	標籤值。
TargetSelection	String	SPECIFIC	升級範圍。 ALL：全量升級。 SPECIFIC：定向升級。 GRAY：灰階升級。說明調用CreateOTADynamicUpgradeJob建立的動態升級批次，該參數僅返回ALL。
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格式。
UtcStartTime	String	2019-12-28T02:43:10.000Z	該批次任務開始執行時的時間，UTC格式。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
PageCount	Integer	1	總頁數。
PageSize	Integer	10	每頁顯示的裝置升級作業數量。
RequestId	String	5D58AC86-D5BF-4B39-834E-913E7F2C985D	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。
Total	Integer	1	裝置升級作業數量總計。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAJobByFirmware
&FirmwareId=FJFx8JzpnhpIsKftRjjm03****
&PageSize=10
&CurrentPage=1
&<公用請求參數>

正常返回樣本

XML格式

<ListOTAJobByFirmwareResponse>
    <PageCount>1</PageCount>
    <Data>
        <SimpleOTAJobInfo>
            <SelectionType>STATIC</SelectionType>
            <TargetSelection>SPECIFIC</TargetSelection>
            <JobType>UPGRADE_FIRMWARE</JobType>
            <FirmwareId>yLYuCqfqQNQ1JOqkDa****0100</FirmwareId>
            <UtcStartTime>2019-12-28T02:43:10.000Z</UtcStartTime>
            <UtcEndTime>2019-12-29T02:43:10.000Z</UtcEndTime>
            <ProductKey>a19mzPZ****</ProductKey>
            <JobId>HvKuBpuk3rdk6E92CP****0200</JobId>
            <UtcModified>2019-12-28T02:43:10.000Z</UtcModified>
            <JobStatus>IN_PROGRESS</JobStatus>
            <UtcCreate>2019-12-28T02:43:10.000Z</UtcCreate>
        </SimpleOTAJobInfo>
    </Data>
    <PageSize>10</PageSize>
    <RequestId>5D58AC86-D5BF-4B39-834E-913E7F2C985D</RequestId>
    <CurrentPage>1</CurrentPage>
    <Success>true</Success>
    <Total>1</Total>
</ListOTAJobByFirmwareResponse>

JSON格式

{
  "PageCount": 1,
  "Data": {
    "SimpleOTAJobInfo": [{
      "SelectionType": "STATIC",
      "TargetSelection": "SPECIFIC",
      "JobType": "UPGRADE_FIRMWARE",
      "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
      "UtcStartTime": "2019-12-28T02:43:10.000Z",
      "UtcEndTime": "2019-12-29T02:43:10.000Z",
      "ProductKey": "a19mzPZ****",
      "JobId": "HvKuBpuk3rdk6E92CP****0200",
      "UtcModified": "2019-12-28T02:43:10.000Z",
      "JobStatus": "IN_PROGRESS",
      "UtcCreate": "2019-12-28T02:43:10.000Z"
    }]
  },
  "PageSize": 10,
  "RequestId": "5D58AC86-D5BF-4B39-834E-913E7F2C985D",
  "CurrentPage": 1,
  "Success": true,
  "Total": 1
}

錯誤碼

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