更新バッチの詳細をクエリします。
使用方法
CreateOTAVerifyJob、CreateOTAStaticUpgradeJob、または CreateOTADynamicUpgradeJob API 操作を呼び出して更新バッチを作成すると、JobId パラメーターが返されます。 このパラメーターを使用して、更新バッチの詳細をクエリできます。
制限
各 Alibaba Cloud アカウントは、最大 10 クエリ/秒(QPS)を実行できます。
デバッグ
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| Action | String | はい | QueryOTAJob | 実行する操作。 値を QueryOTAJob に設定します。 |
| JobId | String | はい | wahVIzGkCMuAUE2gDERM02**** | 更新バッチの ID。 CreateOTAVerifyJob、CreateOTAStaticUpgradeJob、または CreateOTADynamicUpgradeJob API 操作を呼び出して更新バッチを作成した後、JobId パラメーターを取得できます。 IoT Platform コンソールの 更新パッケージの詳細 ページでバッチ ID を表示することもできます。 |
| IotInstanceId | String | いいえ | iot-cn-0pp1n8t**** | インスタンスの ID。IoT Platform コンソールの 概要 ページでインスタンス ID を表示できます。 重要
詳細については、「概要」をご参照ください。 |
上記の操作固有のリクエストパラメータに加えて、この操作を呼び出すときは、共通リクエストパラメータを指定する必要があります。詳細については、「共通リクエストパラメータ」をご参照ください。
レスポンス パラメーター
| パラメーター | タイプ | 例 | 説明 |
| Code | String | iot.system.SystemException | 呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。 |
| Data | Struct | 呼び出しが成功した場合に返される更新バッチ情報。詳細については、以下のパラメーターをご参照ください。 | |
| DestVersion | String | 1.0.1 | 更新の宛先ファームウェアバージョン。 |
| DownloadProtocol | String | HTTPS | 更新パッケージのダウンロードプロトコル。 |
| DynamicMode | Integer | 1 | 動的更新のモード。有効な値:
このパラメーターは、動的更新を実行した場合にのみ返されます。 |
| FirmwareId | String | UfuxnwygsuSkVE0VCN****0100 | 更新パッケージの ID。 |
| GrayPercent | String | 50.00 | 段階的更新のフェーズ比率。 このパラメーターは、段階的更新を実行した場合にのみ返されます。 |
| GroupId | String | CtjzCkNuOxUR*** | 更新対象のデバイスグループの ID。 |
| GroupName | String | test | 更新対象のデバイスグループの名前。 |
| JobDesc | String | batch upgrade | 更新バッチの説明。 |
| JobId | String | HvKuBpuk3rdk6E92CP****0200 | 更新バッチの ID。 |
| JobStatus | String | IN_PROGRESS | 更新バッチのステータス。
|
| JobType | String | UPGRADE_FIRMWARE | バッチのタイプ。有効な値:
|
| MaximumPerMinute | Integer | 1000 | 更新パッケージのダウンロード URL が 1 分あたりにプッシュされるデバイスの最大数。 |
| MultiModuleMode | Boolean | false | デバイスが複数モジュールの同時更新をサポートするかどうかを指定します。
詳細については、「概要」をご参照ください。 |
| Name | String | Firmware2 | 更新パッケージの名前。 |
| NeedConfirm | Boolean | false | モバイルアプリを使用して更新を確認するかどうかを指定します。 |
| NeedPush | Boolean | true | IoT Platform からデバイスに更新タスクを自動的にプッシュするかどうかを指定します。 |
| OverwriteMode | Integer | 1 | 以前の更新タスクを上書きするかどうかを指定します。有効な値:
進行中の更新タスクは上書きされません。 |
| ProductKey | String | a19mzPZ**** | 更新パッケージが属するプロダクトの ProductKey 。 |
| RetryCount | Integer | 1 | デバイスの更新に失敗した後の自動再試行回数。 このパラメーターは、更新バッチの作成時に再試行ポリシーが設定されている場合に返されます。 |
| RetryInterval | Integer | 60 | デバイスの更新に失敗した後の自動再試行間隔。単位:分。 このパラメーターは、更新バッチの作成時に再試行ポリシーが設定されている場合に返されます。 |
| SelectionType | String | STATIC | 更新バッチの更新ポリシー。有効な値:
|
| SrcVersions | List | null | 更新対象のファームウェアバージョンのリスト。 |
| Tags | Array of OtaTagDTO | 更新バッチのタグ。 | |
| OtaTagDTO | |||
| Key | String | key1 | 各タグのキー。 |
| Value | String | value1 | タグの値。 |
| TargetSelection | String | SPECIFIC | 更新バッチの範囲。有効な値:
説明 CreateOTADynamicUpgradeJob API 操作を呼び出して更新バッチを作成した場合、値 ALL が返されます。 |
| TimeoutInMinutes | Integer | 5 | デバイス更新のタイムアウト期間。単位:分。 このパラメーターは、更新バッチの作成時にタイムアウト期間が設定されている場合に返されます。 |
| UtcCreate | String | 2019-12-28T02:43:10.000Z | 更新バッチが作成された時刻。時刻は UTC で表示されます。 |
| UtcEndTime | String | 2019-12-29T02:43:10.000Z | 更新バッチの終了時刻。時刻は UTC で表示されます。 このパラメーターは、更新バッチが完了した後にのみ返されます。 |
| UtcModified | String | 2019-12-28T02:43:10.000Z | 更新バッチが最後に変更された時刻。時刻は UTC で表示されます。 |
| UtcScheduleFinishTime | String | 2019-12-30T02:43:10.000Z | スケジュールされた更新バッチの終了時刻。このパラメーターは、更新バッチがスケジュールされていて、スケジュールされた更新バッチの終了時刻が指定されている場合にのみ返されます。 |
| UtcScheduleTime | String | 2019-12-29T02:43:10.000Z | スケジュールされた更新バッチの開始時刻。このパラメーターは、スケジュールされた更新バッチに対してのみ返されます。 |
| UtcStartTime | String | 2019-12-28T02:43:10.000Z | 更新バッチの開始時刻。時刻は UTC で表示されます。 |
| ErrorMessage | String | A system exception occurred. | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
| RequestId | String | 30F1BB8D-EDBF-44FD-BBC0-BE97DEA73991 | リクエストの ID。 |
| Success | Boolean | true | 呼び出しが成功したかどうかを示します。
|
例
リクエストの例
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryOTAJob
&JobId=wahVIzGkCMuAUE2gDERM02****
&<共通リクエストパラメータ>正常なレスポンスの例
XML 形式
<QueryOTAJobResponse>
<Data>
<TimeoutInMinutes>5</TimeoutInMinutes>
<JobDesc>batch upgrade</JobDesc> JSON 形式
{
"Data": {
"TimeoutInMinutes": 5,
"JobDesc": "batch upgrade", // バッチアップグレード
"DownloadProtocol":"HTTPS",
"UtcStartTime": "2019-12-28T02:43:10.000Z",
"UtcEndTime": "2019-12-29T02:43:10.000Z",
"ProductKey": "a19mzPZ****",
"UtcModified": "2019-12-28T02:43:10.000Z",
"JobStatus": "IN_PROGRESS", // 処理中
"UtcCreate": "2019-12-28T02:43:10.000Z",
"SelectionType": "STATIC",
"TargetSelection": "SPECIFIC",
"JobType": "UPGRADE_FIRMWARE", // ファームウェアのアップグレード
"GroupId":"",
"GroupName":"",
"RetryInterval":60,
"RetryCount":1,
"OverwriteMode":1,
"MultiModuleMode":true,
"MaximumPerMinute":1000,
"SrcVersions": {
"SrcVersion": ["1.0.0"]
},
"Name":"firmware2", // ファームウェア2
"NeedConfirm":true,
"NeedPush":false,
"FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
"JobId": "HvKuBpuk3rdk6E92CP****0200",
"DestVersion": "1.0.1"
},
"RequestId": "30F1BB8D-EDBF-44FD-BBC0-BE97DEA73991",
"Success": true
}レスポンスパラメーター
エラーコードのリストについては、API エラーセンターをご覧ください。