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

無線 (OTA) アップデートパッケージを照会します。

制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	ListOTAFirmware	実行する操作。値を ListOTAFirmware に設定します。
CurrentPage	Integer	Yes	1	返すページ番号。ページは 1 ページ目から始まります。
PageSize	Integer	Yes	10	各ページに返すエントリの数。最大値：100。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
ProductKey	String	No	a19mzPZ****	OTA アップデートパッケージが属するプロダクトの ProductKey。このパラメーターを指定すると、IoT Platform は指定されたプロダクトの OTA アップデートパッケージを返します。このパラメーターを指定しないと、IoT Platform は現在の Alibaba Cloud アカウントの OTA アップデートパッケージを返します。
DestVersion	String	No	4.0.0	OTA アップデートパッケージのバージョン番号。このパラメーターを指定すると、指定されたバージョン番号の OTA アップデートパッケージのみが返されます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
CurrentPage	Integer	1	返されたページ番号。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
FirmwareInfo	SimpleFirmwareInfo の配列		呼び出しが成功した場合に返される OTA アップデートパッケージ。詳細については、SimpleFirmwareInfo をご参照ください。
SimpleFirmwareInfo
DestVersion	String	4.0.0	OTA アップデートパッケージのバージョン番号。
FirmwareDesc	String	firmwareDesc	OTA アップデートパッケージの説明。
FirmwareId	String	UfuxnwygsuSkVE0VCN****0100	OTA アップデートパッケージの一意の ID。
FirmwareName	String	t3q5rkNm	OTA アップデートパッケージの名前。
FirmwareSign	String	3d04ab6462633508606e5f3daac8****	OTA アップデートパッケージの署名。
FirmwareSize	Integer	924	アップデートパッケージのサイズ。単位：バイト。
ModuleName	String	module1234	モジュールの名前。
ProductKey	String	a19mzPZ****	OTA アップデートパッケージが属するプロダクトの ProductKey。
ProductName	String	MyProduct	OTA アップデートパッケージが属するプロダクトの名前。
SignMethod	String	MD5	OTA アップデートパッケージの署名方式。
SrcVersion	String	V1.0.0	アップデートされる元のアップデートパッケージのバージョン番号。説明フルアップデートを実行すると、戻り値は null になります。
Status	Integer	0	OTA アップデートパッケージのステータス。有効な値： 0: 未検証 1: 検証済み 2: 検証中 3: 検証失敗
Type	Integer	0	OTA アップデートパッケージのタイプ。有効な値： 0: 完全ファームウェア 1: 差分ファームウェア
UtcCreate	String	2019-12-28T02:42:22.000Z	アップデートパッケージが作成された日時。時間は UTC で表示されます。
UtcModified	String	2019-12-28T02:42:22.000Z	アップデートタスクが最後に変更された日時。時間は UTC で表示されます。
PageCount	Integer	1	ページの総数。
PageSize	Integer	10	1 ページあたりに返されるエントリの数。
RequestId	String	A01829CE-75A1-4920-B775-921146A1AB79	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。
Total	Integer	1	OTA アップデートパッケージの総数。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAFirmware
&CurrentPage=1
&PageSize=10
&ProductKey=a19mzPZ****
&DestVersion=4.0.0
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<ListOTAFirmwareResponse>
  <PageCount>1</PageCount>
  <PageSize>10</PageSize>
  <RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
  <FirmwareInfo>
        <SimpleFirmwareInfo>
              <SrcVersion>1.0.0</SrcVersion>
              <FirmwareSign>3d04ab6462633508606e5f3daac8****</FirmwareSign>
              <ProductKey>a19mzPZ****</ProductKey>
              <Type>0</Type>
              <UtcModified>2019-12-28T02:42:22.000Z</UtcModified>
              <SignMethod>MD5</SignMethod>
              <UtcCreate>2019-12-28T02:42:22.000Z</UtcCreate>
              <FirmwareSize>924</FirmwareSize>
              <Status>0</Status>
              <FirmwareId>UfuxnwygsuSkVE0VCN****0100</FirmwareId>
              <FirmwareDesc>firmwareDesc</FirmwareDesc>
              <DestVersion>4.0.0</DestVersion>
              <ProductName>MyProduct</ProductName>
              <FirmwareName>t3q5rkNm</FirmwareName>
              <ModuleName>module1234</ModuleName>
        </SimpleFirmwareInfo>
  </FirmwareInfo>
  <CurrentPage>1</CurrentPage>
  <Success>true</Success>
  <Total>1</Total>
</ListOTAFirmwareResponse>

JSON 形式

{
  "PageCount": 1,
  "PageSize": 10,
  "RequestId": "A01829CE-75A1-4920-B775-921146A1AB79",
  "FirmwareInfo": {
    "SimpleFirmwareInfo": [{
      "SrcVersion": "1.0.0",
      "FirmwareSign": "3d04ab6462633508606e5f3daac8****",
      "ProductKey": "a19mzPZ****",
      "Type": 0,
      "UtcModified": "2019-12-28T02:42:22.000Z",
      "SignMethod": "MD5",
      "UtcCreate": "2019-12-28T02:42:22.000Z",
      "FirmwareSize": 924,
      "Status": 0,
      "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
      "FirmwareDesc": "firmwareDesc",
      "DestVersion": "4.0.0",
      "ProductName": "MyProduct",
      "FirmwareName": "t3q5rkNm",
      "ModuleName": "module1234"
    }]
  },
  "CurrentPage": 1,
  "Success": true,
  "Total": 1
}

エラーコード

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