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

デバイスによって送信された無線 (OTA) モジュールのバージョン情報を照会します。

制限

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

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

デバッグ

Alibaba Cloud は、API の使用を簡素化するために OpenAPI Explorer を提供しています。OpenAPI Explorer は署名値を自動的に計算します。便宜上、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 は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
ProductKey	String	いいえ	aluctKe****	デバイスが属するプロダクトの ProductKey。説明このパラメーターを指定する場合は、DeviceName パラメーターも指定する必要があります。
DeviceName	String	いいえ	newdevice	照会するデバイスの DeviceName。説明このパラメーターを指定する場合は、ProductKey パラメーターも指定する必要があります。
IotId	String	いいえ	Q7uOhVRdZRRlDnTLv****00100	デバイスの ID。デバイス ID は IoT Platform によって発行されます。説明このパラメーターを指定する場合は、ProductKey または DeviceName を指定する必要はありません。IotId パラメーターは、ProductKey と DeviceName の組み合わせに対応する、デバイスのグローバル一意識別子 (GUID) を指定します。IotId と ProductKey と DeviceName の組み合わせの両方を指定した場合、IotId が優先されます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
CurrentPage	Integer	1	現在のページ番号。
Data	SimpleOTAModuleInfo の配列		呼び出しが成功した場合に返されるモジュールバージョン情報。情報はデバイスによって送信されました。詳細については、この表の SimpleOTAModuleInfo パラメーターを参照してください。
SimpleOTAModuleInfo
DeviceName	String	newDevice	デバイスの DeviceName。
IotId	String	QjIFT***000101	デバイスの ID。
ModuleName	String	barcodeScanner	OTA モジュールの名前。
ModuleVersion	String	1.0	デバイスによって送信されたモジュールバージョン。
ProductKey	String	aluctKe****	デバイスが属するプロダクトの ProductKey。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
PageCount	Integer	1	返されるページの総数。
PageSize	Integer	10	各ページに返されるモジュールバージョンの数。
RequestId	String	291438BA-6E10-4C4C-B761-243B9A0D324F	リクエストの ID。
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"
            }
        ]
    }
}

エラーコード

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