調用ListOTAFirmware介面查詢OTA升級包列表-物聯網平台-阿里雲

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ListOTAFirmware	系統規定參數。取值：ListOTAFirmware。
CurrentPage	Integer	是	1	指定從返回結果中的第幾頁開始顯示。頁數從1開始排序。
PageSize	Integer	是	10	指定返回結果中每頁顯示的韌體數量。最大限制為100。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
ProductKey	String	否	a19mzPZ****	OTA升級包所屬產品的ProductKey。傳入該參數，則查詢指定產品下的OTA升級包列表；不傳入此參數，則返回當前阿里雲帳號下的所有OTA升級包列表。
DestVersion	String	否	4.0.0	OTA升級包版本號碼。傳入該參數，則查詢版本號碼為指定版本號碼的OTA升級包。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
CurrentPage	Integer	1	當前頁碼。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
FirmwareInfo	Array of SimpleFirmwareInfo		調用成功時，返回的OTA升級包列表。詳情參見以下SimpleFirmwareInfo。
SimpleFirmwareInfo
DestVersion	String	4.0.0	當前OTA升級包版本號碼。
FirmwareDesc	String	firmwareDesc	OTA升級包描述資訊。
FirmwareId	String	UfuxnwygsuSkVE0VCN****0100	OTA升級包ID，OTA升級包的唯一識別碼。
FirmwareName	String	t3q5rkNm	OTA升級包名稱。
FirmwareSign	String	3d04ab6462633508606e5f3daac8****	OTA升級包內容的簽名值。
FirmwareSize	Integer	924	OTA升級包大小，單位：位元組。
ModuleName	String	module1234	OTA升級包的模組名稱。
ProductKey	String	a19mzPZ****	OTA升級包所屬產品的ProductKey。
ProductName	String	MyProduct	OTA升級包所屬產品的名稱。
SignMethod	String	MD5	OTA升級包簽名方式。
SrcVersion	String	V1.0.0	待升OTA升級包版本號碼。說明整包OTA升級包返回的該參數為空白。
Status	Integer	0	OTA升級包狀態。 0：未驗證。 1：已驗證。 2：驗證中。 3：驗證失敗。
Type	Integer	0	OTA升級包類型。 0：整包韌體。 1：差分韌體。
UtcCreate	String	2019-12-28T02:42:22.000Z	OTA升級包建立時的時間，UTC格式。
UtcModified	String	2019-12-28T02:42:22.000Z	OTA升級包最後一次修改時的時間，UTC格式。
PageCount	Integer	1	總頁數。
PageSize	Integer	10	每頁顯示的韌體數量。
RequestId	String	A01829CE-75A1-4920-B775-921146A1AB79	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。
Total	Integer	1	OTA升級包數量總計。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAFirmware
&CurrentPage=1
&PageSize=10
&ProductKey=a19mzPZ****
&DestVersion=4.0.0
&<公用請求參數>

正常返回樣本

XML格式

<ListOTAFirmwareResponse>
  <PageCount>1</PageCount>
  <PageSize>10</PageSize>
  <RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
  <FirmwareInfo>
        <SimpleFirmwareInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <FirmwareSign>3d04ab6462633508606e5f3daac8****</FirmwareSign>
              <ProductKey>a19mzPZ****</ProductKey>
              <Type>0</Type>
              <UtcModified>2019-12-28T02:42:22.000Z</UtcModified>
              <SignMethod>MD5</SignMethod>
              <UtcCreate>2019-12-28T02:42:22.000Z</UtcCreate>
              <FirmwareSize>924</FirmwareSize>
              <Status>0</Status>
              <FirmwareId>UfuxnwygsuSkVE0VCN****0100</FirmwareId>
              <FirmwareDesc>firmwareDesc</FirmwareDesc>
              <DestVersion>4.0.0</DestVersion>
              <ProductName>MyProduct</ProductName>
              <FirmwareName>t3q5rkNm</FirmwareName>
              <ModuleName>module1234</ModuleName>
        </SimpleFirmwareInfo>
  </FirmwareInfo>
  <CurrentPage>1</CurrentPage>
  <Success>true</Success>
  <Total>1</Total>
</ListOTAFirmwareResponse>

JSON格式

{
  "PageCount": 1,
  "PageSize": 10,
  "RequestId": "A01829CE-75A1-4920-B775-921146A1AB79",
  "FirmwareInfo": {
    "SimpleFirmwareInfo": [{
      "SrcVersion": "1.0.0",
      "FirmwareSign": "3d04ab6462633508606e5f3daac8****",
      "ProductKey": "a19mzPZ****",
      "Type": 0,
      "UtcModified": "2019-12-28T02:42:22.000Z",
      "SignMethod": "MD5",
      "UtcCreate": "2019-12-28T02:42:22.000Z",
      "FirmwareSize": 924,
      "Status": 0,
      "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
      "FirmwareDesc": "firmwareDesc",
      "DestVersion": "4.0.0",
      "ProductName": "MyProduct",
      "FirmwareName": "t3q5rkNm",
      "ModuleName": "module1234"
    }]
  },
  "CurrentPage": 1,
  "Success": true,
  "Total": 1
}

錯誤碼

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