QueryOTAFirmware - IoT Platform

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryOTAFirmware	系統規定參數。取值：QueryOTAFirmware。
FirmwareId	String	是	s8SSHiKjpBfrM3BSN0z803****	OTA升級包ID，升級包的唯一識別碼。 OTA升級包ID是調用CreateOTAFirmware建立升級包時，返回的參數之一。可以調用ListOTAFirmware，從返回參數中查看。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
FirmwareInfo	Struct		調用成功時，返回的升級包資訊。詳情參見以下FirmwareInfo包含的參數。
DestVersion	String	4.0.0	當前OTA升級包版本號碼。
FirmwareDesc	String	modified-WiFi-module	OTA升級包描述資訊。
FirmwareId	String	UfuxnwygsuSkVE0VCN****0100	OTA升級包ID，升級包的唯一識別碼。
FirmwareName	String	t3q5rkNm	OTA升級包名稱。
FirmwareSign	String	3d04ab6462633508606e5f3daac8****	OTA升級包檔案內容的簽名值。說明 OTA升級包中僅有一個升級包檔案時，返回該參數。
FirmwareSize	Integer	924	OTA升級包檔案大小，單位為位元組。說明 OTA升級包中僅有一個升級包檔案時，返回該參數。
FirmwareUrl	String	https://ota-*.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948/5E962CF83DB1495E8337E9C8A4D1.bin?Expires=1577587360&OSSAccessKeyId=cS8uRRy54Rsz&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH**	OSS儲存升級包檔案的URL。說明 OTA升級包中僅有一個升級包檔案時，返回該參數。
ModuleName	String	WifiConfigModify	OTA升級包的模組名稱。升級包模組用於區分同產品下裝置的不同模組的升級。更多資訊，請參見添加升級包中的自訂OTA模組。
MultiFiles	Array of OtaPackageFileDTO		OTA升級包檔案清單資訊。OTA升級包中有多個升級包檔案時，返回此參數。
FileMd5	String	3d04ab6462633508606e5f3d****	OTA升級包檔案的MD5值。
Name	String	firmware1	OTA升級包檔案名稱。
SignValue	String	3d04ab6462633508606e5f3d****	OTA升級包檔案內容的簽名值。
Size	Integer	200	OTA升級包檔案大小，單位為位元組。
Url	String	https://ota-*.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948/5E962CF83DB1495E8337E9C8A4D1.bin?Expires=1577587360&OSSAccessKeyId=cS8uRRy54Rsz&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH**	OSS儲存升級包檔案的URL。
ProductKey	String	a19mzPZ****	OTA升級包所屬產品的ProductKey。
ProductName	String	MyProduct	OTA升級包所屬產品的名稱。
SignMethod	String	MD5	OTA升級包簽名方式。
SrcVersion	String	1.0.0	待升級的OTA升級包版本號碼。說明僅差分升級的升級包返回該參數。升級包類型的說明，請參見參數Type的描述。
Status	Integer	2	OTA升級包狀態。 -1：不需要驗證。 0：未驗證。 1：已驗證。 2：驗證中。 3：驗證失敗。
Type	Integer	0	OTA升級包類型。 0：整包升級包，您上傳的升級包檔案包含完整的升級包，將推送整包升級包給裝置進行升級。 1：差分升級包，您上傳的升級包檔案僅包含新版本升級包與之前版本的差異部分，僅推送差異部分給裝置進行升級。
Udi	String	{"ota_notice":"升級底層網路攝影機驅動，解決視頻映像模糊的問題。"}	推送給裝置的自訂資訊。不限制常值內容的格式，長度不超過4096個字元。建立升級任務後，物聯網平台向裝置推送升級通知時，會將該自訂資訊下發給裝置。
UtcCreate	String	2019-12-28T02:42:22.000Z	建立OTA升級包的時間，UTC格式。
UtcModified	String	2019-12-28T02:42:41.000Z	OTA升級包最後一次修改時的時間，UTC格式。
VerifyProgress	Integer	0	OTA升級包的驗證進度。 0：未驗證。 100：已完成驗證。 0至100之間的數值N：表示N%的裝置已完成升級。升級包驗證狀態請根據返回參數Status判斷。
RequestId	String	A01829CE-75A1-4920-B775-921146A1AB79	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryOTAFirmware
&FirmwareId=s8SSHiKjpBfrM3BSN0z803****
&<公用請求參數>

正常返回樣本

XML格式

<QueryOTAFirmwareResponse>
  <RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
  <FirmwareInfo>
        <SrcVersion></SrcVersion>
        <FirmwareSign>3d04ab6462633508606e5f3daac8****</FirmwareSign>
        <ProductKey>a19mzPZ****</ProductKey>
        <Type>0</Type>
        <UtcModified>2019-12-28T02:42:41.000Z</UtcModified>
        <SignMethod>MD5</SignMethod>
        <UtcCreate>2019-12-28T02:42:22.000Z</UtcCreate>
        <FirmwareSize>924</FirmwareSize>
        <Status>2</Status>
        <FirmwareId>UfuxnwygsuSkVE0VCN****0100</FirmwareId>
        <FirmwareDesc>modified-WiFi-module</FirmwareDesc>
        <FirmwareUrl>https://ota-***.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948****/5E962CF83DB1495E8337E9C8A4D1****.bin?Expires=1577587360&amp;OSSAccessKeyId=cS8uRRy54Rsz****&amp;Signature=farzC8%2FVMN4HYdEtXvdiC2OevH****</FirmwareUrl>
        <DestVersion>4.0.0</DestVersion>
        <ProductName>MyProduct</ProductName>
        <FirmwareName>t3q5rkNm</FirmwareName>
        <ModuleName>WifiConfigModify</ModuleName>
        <Udi>{"ota_notice":"升級底層網路攝影機驅動，解決視頻映像模糊的問題。"}</Udi>
        <VerifyProgress>0</VerifyProgress>
  </FirmwareInfo>
  <Success>true</Success>
</QueryOTAFirmwareResponse>

JSON格式

{
  "RequestId": "A01829CE-75A1-4920-B775-921146A1AB79",
  "FirmwareInfo": {
    "SrcVersion": "",
    "FirmwareSign": "3d04ab6462633508606e5f3daac8****",
    "ProductKey": "a19mzPZ****",
    "Type": 0,
    "UtcModified": "2019-12-28T02:42:41.000Z",
    "SignMethod": "MD5",
    "UtcCreate": "2019-12-28T02:42:22.000Z",
    "FirmwareSize": 924,
    "Status": 2,
    "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
    "FirmwareDesc": "modified-WiFi-module",
    "FirmwareUrl": "https://ota-***.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948****/5E962CF83DB1495E8337E9C8A4D1****.bin?Expires=1577587360&OSSAccessKeyId=cS8uRRy54Rsz****&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH****",
    "DestVersion": "4.0.0",
    "ProductName": "MyProduct",
    "FirmwareName": "t3q5rkNm",
    "ModuleName": "WifiConfigModify",
    "Udi":"{\"ota_notice\":\"升級底層網路攝影機驅動，解決視頻映像模糊的問題。\"}",
    "VerifyProgress": 0
  },
  "Success": true
}

錯誤碼

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