無線 (OTA) アップデートパッケージを検証するタスクを作成します。
使用上の注意
- 一括更新のためにデバイスにパッケージをプッシュする前に、アップデートパッケージを検証する必要があります。検証済みのアップデートパッケージのみを使用して、デバイスを一括更新できます。QueryOTAFirmware 操作を呼び出して、検証タスクのステータスを表示できます。
- 検証中または検証に合格したアップデートパッケージの検証タスクを開始することはできません。
- 検証タスクには最大 10 台のデバイスを指定できます。
QPS 制限
この API 操作は、アカウントごとに 1 秒あたり最大 10 回呼び出すことができます。
デバッグ
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| Action | String | はい | CreateOTAVerifyJob | 実行する操作。値を CreateOTAVerifyJob に設定します。 |
| FirmwareId | String | はい | nx3xxVvFdwvn6dim50PY03**** | アップデートパッケージの ID。 FirmwareId パラメーターは、CreateOTAFirmware 操作を呼び出して OTA アップデートパッケージを作成すると返されます。 ListOTAFirmware 操作を呼び出して、パッケージ ID を取得することもできます。 |
| ProductKey | String | はい | a1VJwBw**** | OTA アップデートパッケージが属する製品の ProductKey。 |
| Tag.N.Key | String | はい | key1 | 更新バッチタグのキー。キーは 1 ～ 30 文字で、文字、数字、ピリオド (.) を使用できます。更新バッチには最大 10 個のタグを追加できます。 更新バッチのタグは、IoT Platform がデバイスに更新通知をプッシュするときにデバイスに送信されます。 説明 更新バッチタグはオプションです。タグを指定する場合は、Tag.N.Value パラメーターと Tag.N.Key パラメーターをペアで設定する必要があります。 |
| Tag.N.Value | String | はい | value1 | 更新バッチタグの値。値は 1 ～ 1,024 文字である必要があります。更新バッチごとに最大 10 個のタグを追加できます。すべての更新バッチのタグキーとタグ値の合計の長さは 4,096 文字を超えることはできません。 説明 更新バッチタグはオプションです。タグを指定する場合は、Tag.N.Value パラメーターと Tag.N.Key パラメーターをペアで設定する必要があります。 |
| TargetDeviceName.N | RepeatList | はい | testdevice | 検証タスクで指定するデバイス。 説明
|
| IotInstanceId | String | いいえ | iot_instc_pu****_c*-v64******** | IoT インスタンスの ID。インスタンス ID は、IoT Platform コンソールの 概要 ページで確認できます。 重要
詳細については、「概要」をご参照ください。 |
| TimeoutInMinutes | Integer | いいえ | 1440 | デバイスがファームウェアを更新するタイムアウト期間。単位: 分。有効な値: 1 ～ 1440。 |
| NeedPush | Boolean | いいえ | true | IoT Platform からデバイスに更新タスクを自動的にプッシュするかどうかを指定します。有効な値:
|
| NeedConfirm | Boolean | いいえ | false | モバイルアプリを使用して更新を確認するかどうかを指定します。ビジネス要件に基づいてモバイルアプリを開発する必要があります。有効な値:
|
| DownloadProtocol | String | いいえ | HTTPS | アップデートパッケージのダウンロードプロトコル。有効な値: HTTPS および MQTT。デフォルト値: HTTPS。デバイスが IoT Platform によってプッシュされたアップデートパッケージ情報を受信した後、プロトコルを使用してアップデートパッケージをダウンロードします。 重要
|
上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通リクエストパラメーターを設定する必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| Code | String | iot.system.SystemException | 呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。 |
| Data | Struct | 呼び出しが成功した場合に返されるタスク情報。詳細については、以下のパラメーターを参照してください。 | |
| JobId | String | wahVIzGkCMuAUE2gDERM02**** | 検証タスクの ID。 |
| UtcCreate | String | 2019-11-04T06:22:19.566Z | 検証タスクが作成された時刻。時刻は UTC で表示されます。 |
| ErrorMessage | String | システム例外が発生しました。 | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
| RequestId | String | 29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1 | リクエスト ID。 |
| Success | Boolean | true | リクエストが成功したかどうかを示します。有効な値:
|
例
リクエストの例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateOTAVerifyJob
&FirmwareId=nx3xxVvFdwvn6dim50PY03****
&ProductKey=a1VJwBw****
&Tag.1.Key=key1
&Tag.1.Value=value1
&TargetDeviceName.1=testdevice
&TimeoutInMinutes=1440
&<共通リクエストパラメーター>成功レスポンスの例
XML 形式
<CreateOTAVerifyJobResponse>
<Data>
<JobId>wahVIzGkCMuAUE2gDERM02****</JobId>
<UtcCreate>2019-11-04T06:22:19.566Z</UtcCreate>
</Data>
<RequestId>29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1</RequestId>
<Success>true</Success>
</CreateOTAVerifyJobResponse>JSON 形式
{
"Data": {
"JobId": "wahVIzGkCMuAUE2gDERM02****",
"UtcCreate": "2019-11-04T06:22:19.566Z"
},
"RequestId": "29EC7245-0FA4-4BB6-B4F5-5F04818FDFB1",
"Success": true
}エラーコード
エラーコードのリストについては、API エラーセンターをご覧ください。