指定されたファームウェアアップデートパッケージの詳細 (アップデートパッケージの名前、種類、ステータスなど) をクエリします。
制限
Alibaba Cloud アカウントごとに、最大 20 クエリ/秒 (QPS) を実行できます。
デバッグ
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| Action | String | はい | QueryOTAFirmware | 実行する操作。値を QueryOTAFirmware に設定します。 |
| FirmwareId | String | はい | s8SSHiKjpBfrM3BSN0z803**** | ファームウェアアップデートパッケージの一意の ID。 CreateOTAFirmware 操作を呼び出してアップデートパッケージを作成すると、アップデートパッケージ ID が返されます。 ListOTAFirmware 操作を呼び出し、レスポンスでアップデートパッケージ ID を表示できます。 |
| IotInstanceId | String | いいえ | iot_instc_pu****_c*-v64******** | インスタンスの ID。 IoT Platform コンソール の [概要] ページでインスタンスの [ID] を表示できます。 重要
詳細については、「概要」をご参照ください。 |
上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| Code | String | iot.system.SystemException | 呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。 |
| ErrorMessage | String | システム例外が発生しました。 | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
| FirmwareInfo | Struct | 呼び出しが成功した場合に返されるアップデートパッケージ情報。詳細については、FirmwareInfo をご参照ください。 | |
| DestVersion | String | 4.0.0 | ファームウェアアップデートパッケージのバージョン番号。 |
| FirmwareDesc | String | modified-WiFi-module | ファームウェアアップデートパッケージの説明。 |
| FirmwareId | String | UfuxnwygsuSkVE0VCN****0100 | ファームウェアアップデートパッケージの一意の ID。 |
| FirmwareName | String | t3q5rkNm | ファームウェアアップデートパッケージの名前。 |
| FirmwareSign | String | 3d04ab6462633508606e5f3daac8**** | ファームウェアアップデートパッケージの署名。 説明 このパラメーターは、ファームウェアアップデートパッケージに単一のファイルが含まれている場合に利用できます。 |
| FirmwareSize | Integer | 924 | ファームウェアアップデートパッケージファイルのサイズ。単位：バイト。 説明 このパラメーターは、ファームウェアアップデートパッケージに単一のファイルが含まれている場合に利用できます。 |
| FirmwareUrl | String | https://ota-***.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948****/5E962CF83DB1495E8337E9C8A4D1****.bin?Expires=1577587360&OSSAccessKeyId=cS8uRRy54Rsz****&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH**** | Object Storage Service (OSS) に保存されているアップデートパッケージファイルの URL。 説明 このパラメーターは、ファームウェアアップデートパッケージに単一のファイルが含まれている場合に利用できます。 |
| ModuleName | String | WifiConfigModify | モジュールの名前。 ファームウェアアップデートは、デバイスのファームウェアモジュールに基づいています。詳細については、「アップデートパッケージにカスタム OTA モジュールを追加する」をご参照ください。 |
| MultiFiles | Array of OtaPackageFileDTO | ファームウェアアップデートパッケージファイルに関する情報。このパラメーターは、ファームウェアアップデートパッケージに複数のファイルが含まれている場合に利用できます。 | |
| FileMd5 | String | 3d04ab6462633508606e5f3d**** | ファームウェアアップデートパッケージファイルの MD5 値。 |
| Name | String | firmware1 | ファームウェアアップデートパッケージファイルの名前。 |
| SignValue | String | 3d04ab6462633508606e5f3d**** | ファームウェアアップデートパッケージファイルの署名。 |
| Size | Integer | 200 | ファームウェアアップデートパッケージファイルのサイズ。単位：バイト。 |
| Url | String | https://ota-***.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948****/5E962CF83DB1495E8337E9C8A4D1****.bin?Expires=1577587360&OSSAccessKeyId=cS8uRRy54Rsz****&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH**** | Object Storage Service (OSS) に保存されているアップデートパッケージファイルの URL。 |
| ProductKey | String | a19mzPZ**** | ProductKey は、OTA アップデート パッケージが属するプロダクトの ProductKey です。 |
| ProductName | String | MyProduct | ファームウェアアップデートパッケージが属するプロダクトの名前。 |
| SignMethod | String | MD5 | ファームウェアアップデートパッケージの署名方式。 |
| SrcVersion | String | 1.0.0 | アップデートされる元のアップデートパッケージのバージョン番号。 説明 このパラメーターは、デルタアップデートを実行した場合に返されます。アップデートパッケージの種類の詳細については、Type パラメーターの説明をご参照ください。 |
| Status | Integer | 2 | ファームウェアアップデートパッケージのステータス。有効な値：
|
| Type | Integer | 0 | ファームウェアアップデートパッケージのタイプ。有効な値：
|
| Udi | String | {"ota_notice":"Upgrade the underlying camera driver to solve the problem of blurred video images. "} | デバイスにプッシュされたカスタム情報。情報は最大 4,096 文字です。コンテンツ形式に制限はありません。 アップデートパッケージを追加してアップデートタスクを作成した後、IoT Platform はアップデート通知をプッシュするときに、指定されたデバイスにカスタム情報を送信します。 |
| UtcCreate | String | 2019-12-28T02:42:22.000Z | ファームウェアアップデートパッケージが作成された時刻。時刻は UTC で表示されます。 |
| UtcModified | String | 2019-12-28T02:42:41.000Z | アップデートタスクが最後に変更された時刻。時刻は UTC で表示されます。 |
| VerifyProgress | Integer | 0 | ファームウェアアップデートパッケージの検証ステータス。有効な値：
|
| RequestId | String | A01829CE-75A1-4920-B775-921146A1AB79 | リクエストの ID。 |
| Success | Boolean | true | 呼び出しが成功したかどうかを示します。
|
例
リクエストの例
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryOTAFirmware
&FirmwareId=s8SSHiKjpBfrM3BSN0z803****
&<共通リクエストパラメーター>成功レスポンスの例
XML 形式
<QueryOTAFirmwareResponse>
<RequestId>A01829CE-75A1-4920-B775-921146A1AB79</RequestId>
<FirmwareInfo>
<SrcVersion></SrcVersion>
<FirmwareSign>3d04ab6462633508606e5f3daac8****</FirmwareSign>
<ProductKey>a19mzPZ****</ProductKey>
<Type>0</Type>
<UtcModified>2019-12-28T02:42:41.000Z</UtcModified>
<SignMethod>MD5</SignMethod>
<UtcCreate>2019-12-28T02:42:22.000Z</UtcCreate>
<FirmwareSize>924</FirmwareSize>
<Status>2</Status>
<FirmwareId>UfuxnwygsuSkVE0VCN****0100</FirmwareId>
<FirmwareDesc>modified-WiFi-module</FirmwareDesc>
<FirmwareUrl>https://ota-***.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948****/5E962CF83DB1495E8337E9C8A4D1****.bin?Expires=1577587360&OSSAccessKeyId=cS8uRRy54Rsz****&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH****</FirmwareUrl>
<DestVersion>4.0.0</DestVersion>
<ProductName>MyProduct</ProductName>
<FirmwareName>t3q5rkNm</FirmwareName>
<ModuleName>WifiConfigModify</ModuleName>
<Udi>{"ota_notice":"Upgrade the underlying camera driver to solve the problem of blurred video images. "}</Udi>
<VerifyProgress>0</VerifyProgress>
</FirmwareInfo>
<Success>true</Success>
</QueryOTAFirmwareResponse>JSON 形式
{
"RequestId": "A01829CE-75A1-4920-B775-921146A1AB79",
"FirmwareInfo": {
"SrcVersion": "",
"FirmwareSign": "3d04ab6462633508606e5f3daac8****",
"ProductKey": "a19mzPZ****",
"Type": 0,
"UtcModified": "2019-12-28T02:42:41.000Z",
"SignMethod": "MD5",
"UtcCreate": "2019-12-28T02:42:22.000Z",
"FirmwareSize": 924,
"Status": 2,
"FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
"FirmwareDesc": "modified-WiFi-module",
"FirmwareUrl": "https://ota-***.aliyuncs.com/ota/572ef2fd12ca4791a5b21a9eb948****/5E962CF83DB1495E8337E9C8A4D1****.bin?Expires=1577587360&OSSAccessKeyId=cS8uRRy54Rsz****&Signature=farzC8%2FVMN4HYdEtXvdiC2OevH****",
"DestVersion": "4.0.0",
"ProductName": "MyProduct",
"FirmwareName": "t3q5rkNm",
"ModuleName": "WifiConfigModify",
"Udi":"{\"ota_notice\":\" Upgrade the underlying camera driver to solve the problem of blurred video images. \"}",
"VerifyProgress": 0
},
"Success": true
}エラーコード
エラーコードのリストについては、API エラーセンター をご参照ください。