ListOTAModuleByProduct - IoT Platform - Alibaba Cloud ドキュメントセンター

製品のすべての OTA モジュールをクエリします。

制限

各 Alibaba Cloud アカウントは、最大 10 クエリ/秒（QPS）を実行できます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	ListOTAModuleByProduct	実行する操作。値を ListOTAModuleByProduct に設定します。
ProductKey	String	はい	a1uctKe****	製品の ProductKey。
IotInstanceId	String	いいえ	iot-cn-0pp1n8t****	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	OtaModuleDTO の配列		呼び出しが成功した場合に返される OTA モジュール。
AliasName	String	Barcode_scanner	OTA モジュールのエイリアス。
Desc	String	This module represents the firmware of the barcode scanner.	OTA モジュールの説明。
GmtCreate	String	2020-10-13T09:46Z	OTA モジュールが作成された日時。時間は UTC で表示されます。
GmtModified	String	2020-10-19T09:46Z	OTA モジュールが最後に更新された日時。時間は UTC で表示されます。
ModuleName	String	barcodeScanner	OTA モジュールの名前。
ProductKey	String	aluctKe****	製品の ProductKey。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	74C2BB8D-1D6F-41F5-AE68-6B2310883F63	リクエストの ID。
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>This module represents the firmware of the barcode scanner.</Desc>
            <GmtCreate>2020-10-13T09:46Z</GmtCreate>
            <ModuleName>barcodeScanner</ModuleName>
            <AliasName>Barcode_scanner</AliasName>
            <GmtModified>2020-10-19T09:46Z</GmtModified>
            <ProductKey>a1uctKe****</ProductKey>
      </Data>
      <Success>true</Success>
</ListOTAModuleByProductResponse>

JSON 形式

{
    "Data": {
        "Desc": "This module represents the firmware of the barcode scanner.",
        "GmtCreate": "2020-10-13T09:46Z",
        "ModuleName": "barcodeScanner",
        "AliasName": "Barcode_scanner",
        "GmtModified": "2020-10-19T09:46Z",
        "ProductKey": "a1uctKe****"
    },
    "RequestId": "74C2BB8D-1D6F-41F5-AE68-6B2310883F63",
    "Success": true
}

エラーコード

エラーコードのリストについては、API エラーセンターにアクセスしてください。