ListOTAModuleByProduct - IoT Platform

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ListOTAModuleByProduct	系統規定參數。取值：ListOTAModuleByProduct。
ProductKey	String	是	a1uctKe****	產品的ProductKey。
IotInstanceId	String	否	iot-cn-0pp1n8t****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Array of OtaModuleDTO		調用成功時，返回的OTA模組列表。
AliasName	String	條碼掃描器	模組別名。
Desc	String	這個模組對應於條碼掃描器的韌體	模組描述。
GmtCreate	String	2020-10-13T09:46Z	模組建立時間，GMT格式。
GmtModified	String	2020-10-19T09:46Z	模組資訊最後一次更新時間，GMT格式。
ModuleName	String	barcodeScanner	模組名稱。
ProductKey	String	aluctKe****	產品的ProductKey。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	74C2BB8D-1D6F-41F5-AE68-6B2310883F63	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAModuleByProduct
&ProductKey=a1uctKe****
&<公用請求參數>

正常返回樣本

XML格式

<ListOTAModuleByProductResponse>
      <RequestId>74C2BB8D-1D6F-41F5-AE68-6B2310883F63</RequestId>
      <Data>
            <Desc>這個模組對應於條碼掃描器的韌體</Desc>
            <GmtCreate>2020-10-13T09:46Z</GmtCreate>
            <ModuleName>barcodeScanner</ModuleName>
            <AliasName>條碼掃描器</AliasName>
            <GmtModified>2020-10-19T09:46Z</GmtModified>
            <ProductKey>a1uctKe****</ProductKey>
      </Data>
      <Success>true</Success>
</ListOTAModuleByProductResponse>

JSON格式

{
    "Data": {
        "Desc": "這個模組對應於條碼掃描器的韌體",
        "GmtCreate": "2020-10-13T09:46Z",
        "ModuleName": "barcodeScanner",
        "AliasName": "條碼掃描器",
        "GmtModified": "2020-10-19T09:46Z",
        "ProductKey": "a1uctKe****"
    },
    "RequestId": "74C2BB8D-1D6F-41F5-AE68-6B2310883F63",
    "Success": true
}

錯誤碼

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