ListOTAModuleVersionsByDevice - IoT Platform

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ListOTAModuleVersionsByDevice	系統規定參數。取值：ListOTAModuleVersionsByDevice。
CurrentPage	Integer	是	1	指定從返回結果中的第幾頁開始顯示。預設值是1。
PageSize	Integer	是	10	指定返回結果中每頁顯示的模組版本數量。數量限制：每頁最多可顯示200條。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
ProductKey	String	否	aluctKe****	要查詢裝置所屬的產品ProductKey。說明如果傳入該參數，需同時傳入DeviceName。
DeviceName	String	否	newdevice	指定要查詢裝置的名稱。說明如果傳入該參數，需同時傳入ProductKey。
IotId	String	否	Q7uOhVRdZRRlDnTLv****00100	要查詢的裝置ID。物聯網平台為該裝置頒發的ID，裝置的唯一識別碼。說明如果傳入該參數，則無需傳入ProductKey和DeviceName。IotId作為裝置唯一識別碼，和ProductKey與DeviceName組合是一一對應的關係。如果您同時傳入IotId和ProductKey與DeviceName組合，則以IotId為準。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
CurrentPage	Integer	1	當前頁面號。
Data	Array of SimpleOTAModuleInfo		調用成功時，返回的裝置上報的模組版本資訊。更多資訊，請參見以下SimpleOTAModuleInfo資訊。
SimpleOTAModuleInfo
DeviceName	String	newDevice	裝置名稱。
IotId	String	QjIFT***000101	裝置ID。
ModuleName	String	barcodeScanner	模組名稱。
ModuleVersion	String	1.0	裝置上報的模組版本。
ProductKey	String	aluctKe****	裝置所屬產品的ProductKey。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
PageCount	Integer	1	返回的總頁數。
PageSize	Integer	10	每頁顯示的模組版本數量。
RequestId	String	291438BA-6E10-4C4C-B761-243B9A0D324F	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。
Total	Integer	10	裝置上報的模組版本總數。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAModuleVersionsByDevice
&CurrentPage=1
&PageSize=10
&<公用請求參數>

正常返回樣本

XML格式

<ListOTAModuleVersionsByDeviceResponse>
  <requestId>67AF7881-704C-40CC-B296-72F91380A117</requestId>
  <success>true</success>
  <code></code>
  <errorMessage></errorMessage>
  <PageSize>10</PageSize>
  <PageCount>1</PageCount>
  <CurrentPage>1</CurrentPage>
  <Total>1</Total>
  <Data>
        <SimpleOTAModuleInfo>
              <IotId>QjIFT***000101</IotId>
              <ModuleVersion>1.6940.1</ModuleVersion>
              <ModuleName>default</ModuleName>
              <ProductKey>a14***S</ProductKey>
              <DeviceName>newDevice</DeviceName>
        </SimpleOTAModuleInfo>
  </Data>
</ListOTAModuleVersionsByDeviceResponse>

JSON格式

{
    "requestId": "67AF7881-704C-40CC-B296-72F91380A117",
    "success": true,
    "code": "",
    "errorMessage": null,
    "PageSize": 10,
    "PageCount": 1,
    "CurrentPage": 1,
    "Total": 1,
    "Data": {
        "SimpleOTAModuleInfo": [
            {
                "IotId": "QjIFT***000101",
                "ModuleVersion": "1.6940.1",
                "ModuleName": "default",
                "ProductKey": "a14***S",
                "DeviceName": "newDevice"
            }
        ]
    }
}

錯誤碼

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