IoT Platform:CreateOTAStaticUpgradeJob

実行する操作。 値を CreateOTAStaticUpgradeJob に設定します。

アップデートパッケージの ID。

CreateOTAFirmware 操作を呼び出してアップデートパッケージを作成すると、アップデートパッケージ ID が返されます。

ListOTAFirmware 操作を呼び出して ID を取得することもできます。

アップデートパッケージが属するプロダクトの ProductKey。

ProductKey は、IoT Platform におけるプロダクトの一意の識別子です。 IoT Platform コンソールで、または QueryProductList 操作を呼び出すことで、現在の Alibaba Cloud アカウント内のすべてのプロダクトに関する情報を表示できます。

アップデートバッチタグのキー。 キーは 1 ～ 30 文字で、文字、数字、ピリオド (.) を使用できます。 アップデートバッチごとに最大 10 個のタグを追加できます。

アップデートバッチのタグは、IoT Platform がこれらのデバイスにアップデート通知をプッシュするときにデバイスに送信されます。

アップデートバッチタグの値。 値は 1 ～ 1,024 文字でなければなりません。 アップデートバッチごとに最大 10 個のタグを追加できます。 すべてのアップデートバッチのタグキーとタグ値の合計の長さは、4,096 文字を超えることはできません。

アップデートバッチの範囲。 有効な値：

• ALL: すべてのデバイスをアップデートします。
• SPECIFIC: 指定されたデバイスをアップデートします。
• GRAY: 段階的アップデートを実行します。
• GROUP: 指定されたグループをアップデートします。

インスタンスの ID。 インスタンスの ID は、IoT Platform コンソールの 概要 ページで確認できます。

詳細については、「概要」をご参照ください。

アップデート対象のファームウェアバージョンのリスト。

ファームウェアアップデート (OTA) を開始する時刻。

スケジュールされた時刻は、現在の時刻から 5 分後から 7 日後までです。 値は 13 桁のタイムスタンプである必要があります。

このパラメーターを指定しないと、アップデートはすぐに開始されます。

デバイスのアップデートに失敗した場合の自動再試行間隔。 単位：分。 有効な値：

• 0: 自動再試行がすぐに実行されます。
• 10: 10 分後に自動再試行が実行されます。
• 30: 30 分後に自動再試行が実行されます。
• 60: 60 分 (1 時間) 後に自動再試行が実行されます。
• 1440: 1,440 分 (24 時間) 後に自動再試行が実行されます。

このパラメーターを指定しないと、再試行は実行されません。

自動再試行の回数。

RetryInterval パラメーターを指定する場合は、このパラメーターを指定する必要があります。

有効な値：

• 1: 1 回再試行します。
• 2: 2 回再試行します。
• 5: 5 回再試行します。

アップデートのタイムアウト期間。 指定された期間内にデバイスがアップデートされない場合、タイムアウトエラーが発生します。 単位：分。 有効な値：1 ～ 1440。

このパラメーターを指定しないと、タイムアウトエラーは発生しません。

アップデートパッケージのダウンロード URL が 1 分あたりにプッシュされるデバイスの最大数。 有効な値：10 ～ 10000。

デフォルト値：10000。

段階的アップデートの比率。 値は文字列形式のパーセンテージです。 最大 3 桁の少数まで使用できます。 計算されたデバイスの数は、最も近い整数に切り捨てられます。 段階的アップデートでは、少なくとも 1 つのデバイスを指定する必要があります。

たとえば、100 台のデバイスに対して段階的アップデートの比率を 33.33 に設定した場合、アップデートされるデバイスの数は 33 になります。

TargetSelection パラメーターを GRAY に設定する場合は、このパラメーターを指定する必要があります。

デバイス名のリスト。

アップデートを終了する時刻。

終了時刻は、ScheduleTime パラメーターで指定された開始時刻の 1 時間後から 30 日後までである必要があります。 値は 13 桁のタイムスタンプである必要があります。

このパラメーターを指定しないと、アップデートは強制終了されません。

以前のアップデートタスクを上書きするかどうかを指定します。 デフォルト値：1。 有効な値：

• 1: 以前のアップデートタスクは上書きされません。 デバイスにすでにアップデートタスクがある場合、以前のアップデートタスクが実装されます。
• 2: 以前のアップデートタスクは上書きされます。 現在のアップデートタスクのみが実装されます。 この場合、MultiModuleMode を true に設定することはできません。

特定のアップデートを実行するために使用されるデバイスリストファイルの URL。

IoT Platform からデバイスにアップデートタスクを自動的にプッシュするかどうかを指定します。 デフォルト値：true。 有効な値：

• true: アップデートバッチが作成されると、IoT Platform は指定されたオンラインデバイスにアップデートタスクを自動的にプッシュします。

  この場合でも、デバイスは IoT Platform からファームウェアアップデート (OTA) タスクに関する情報を取得するリクエストを開始できます。

• false: デバイスは、IoT Platform から OTA アップデートタスクに関する情報を取得するリクエストを開始する必要があります。

モバイルアプリを使用してアップデートを制御するかどうかを指定します。 必要に応じてモバイルアプリを開発する必要があります。 デフォルト false: true。 有効な値：

• false: デバイスは、NeedPush パラメーターに基づいて OTA アップデートタスクに関する情報を取得します。
• true: デバイスで OTA アップデートを実行するには、モバイルアプリを使用してアップデートを確認する必要があります。 その後、デバイスは NeedPush パラメーターに基づいて OTA アップデートタスクに関する情報を取得できます。

グループの ID。

TargetSelection パラメーターを GROUP に設定する場合は、このパラメーターと GroupType パラメーターを指定する必要があります。

QueryDeviceGroupList 操作を呼び出して、GroupId パラメーターをクエリできます。

グループのタイプ。 有効な値：LINK_PLATFORM。

TargetSelection パラメーターを GROUP に設定する場合は、このパラメーターと GroupId パラメーターを指定する必要があります。

アップデートパッケージのダウンロードプロトコル。 有効な値：HTTPS および MQTT。 デフォルト値：HTTPS。 デバイスは、IoT Platform によってプッシュされたアップデートパッケージ情報を受信した後、このプロトコルを使用してアップデートパッケージをダウンロードします。

デバイスが複数モジュールの同時アップデートをサポートするかどうかを指定します。 デフォルト値：false。 有効な値：

• false

• true: この場合、OverwriteMode を 2 に設定しないでください。

  同じモジュールのアップデートタスクは上書きされます。 進行中のアップデートタスクは上書きされません。 モジュールのアップデートタスクは互いに影響しません。

詳細については、「概要」をご参照ください。

呼び出しに失敗した場合に返されるエラーコード。 詳細については、「エラーコード」をご参照ください。

呼び出しに失敗した場合に返されるエラーメッセージ。

リクエストの ID。

呼び出しが成功したかどうかを示します。 有効な値：

• true: リクエストは成功しました。
• false: リクエストは失敗しました。