すべてのプロダクト
Search
ドキュメントセンター

IoT Platform:QueryOTAJob

最終更新日:Apr 17, 2025

更新バッチの詳細をクエリします。

使用方法

CreateOTAVerifyJobCreateOTAStaticUpgradeJob、または CreateOTADynamicUpgradeJob API 操作を呼び出して更新バッチを作成すると、JobId パラメーターが返されます。 このパラメーターを使用して、更新バッチの詳細をクエリできます。

制限

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

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

デバッグ

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

リクエストパラメーター

パラメータータイプ必須説明
ActionStringはいQueryOTAJob

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

JobIdStringはいwahVIzGkCMuAUE2gDERM02****

更新バッチの ID。

CreateOTAVerifyJobCreateOTAStaticUpgradeJob、または CreateOTADynamicUpgradeJob API 操作を呼び出して更新バッチを作成した後、JobId パラメーターを取得できます。 IoT Platform コンソールの 更新パッケージの詳細 ページでバッチ ID を表示することもできます。

IotInstanceIdStringいいえiot-cn-0pp1n8t****

インスタンスの ID。IoT Platform コンソールの 概要 ページでインスタンス ID を表示できます。

重要
  • インスタンスに ID がある場合は、このパラメーターを設定する必要があります。 このパラメーターを設定しないと、呼び出しは失敗します。
  • インスタンスに 概要 ページまたは ID がない場合は、このパラメーターを設定する必要はありません。

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

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

レスポンス パラメーター

パラメータータイプ説明
CodeStringiot.system.SystemException

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

DataStruct

呼び出しが成功した場合に返される更新バッチ情報。詳細については、以下のパラメーターをご参照ください。

DestVersionString1.0.1

更新の宛先ファームウェアバージョン。

DownloadProtocolStringHTTPS

更新パッケージのダウンロードプロトコル。

DynamicModeInteger1

動的更新のモード。有効な値:

  • 1: 条件を満たすデバイスを常に更新します。
  • 2: 最新のファームウェアバージョンを後で送信するデバイスのみを更新します。

このパラメーターは、動的更新を実行した場合にのみ返されます。

FirmwareIdStringUfuxnwygsuSkVE0VCN****0100

更新パッケージの ID。

GrayPercentString50.00

段階的更新のフェーズ比率。

このパラメーターは、段階的更新を実行した場合にのみ返されます。

GroupIdStringCtjzCkNuOxUR***

更新対象のデバイスグループの ID。

GroupNameStringtest

更新対象のデバイスグループの名前。

JobDescStringbatch upgrade

更新バッチの説明。

JobIdStringHvKuBpuk3rdk6E92CP****0200

更新バッチの ID。

JobStatusStringIN_PROGRESS

更新バッチのステータス。

  • PLANNED: 更新バッチは計画中です。バッチは作成されていますが、スケジュールされた時刻はまだ到着していません。このパラメーターは、静的更新を実行した場合にのみ返されます。
  • IN_PROGRESS: 更新バッチは実行中です。
  • COMPLETED: 更新バッチは完了しました。
  • CANCELED: 更新バッチはキャンセルされました。
JobTypeStringUPGRADE_FIRMWARE

バッチのタイプ。有効な値:

  • VERFIY_FIRMWARE: 更新パッケージの検証。
  • UPGRADE_FIRMWARE: バッチ更新。
MaximumPerMinuteInteger1000

更新パッケージのダウンロード URL が 1 分あたりにプッシュされるデバイスの最大数。

MultiModuleModeBooleanfalse

デバイスが複数モジュールの同時更新をサポートするかどうかを指定します。

  • false (デフォルト): いいえ。
  • true: はい。

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

NameStringFirmware2

更新パッケージの名前。

NeedConfirmBooleanfalse

モバイルアプリを使用して更新を確認するかどうかを指定します。

NeedPushBooleantrue

IoT Platform からデバイスに更新タスクを自動的にプッシュするかどうかを指定します。

OverwriteModeInteger1

以前の更新タスクを上書きするかどうかを指定します。有効な値:

  • 1: 以前の更新タスクは上書きされません。デバイスに既に更新タスクがある場合、以前の更新タスクが実装されます。
  • 2: 以前の更新タスクは上書きされます。現在の更新タスクのみが実装されます。

進行中の更新タスクは上書きされません。

ProductKeyStringa19mzPZ****

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

RetryCountInteger1

デバイスの更新に失敗した後の自動再試行回数。

このパラメーターは、更新バッチの作成時に再試行ポリシーが設定されている場合に返されます。

RetryIntervalInteger60

デバイスの更新に失敗した後の自動再試行間隔。単位:分。

このパラメーターは、更新バッチの作成時に再試行ポリシーが設定されている場合に返されます。

SelectionTypeStringSTATIC

更新バッチの更新ポリシー。有効な値:

  • DYNAMIC: 動的更新。CreateOTADynamicUpgradeJob API 操作を呼び出して更新バッチを作成した場合、この値が返されます。
  • STATIC: 静的更新。CreateOTAStaticUpgradeJob API 操作を呼び出して更新バッチを作成した場合、この値が返されます。
SrcVersionsListnull

更新対象のファームウェアバージョンのリスト。

TagsArray of OtaTagDTO

更新バッチのタグ。

OtaTagDTO
KeyStringkey1

各タグのキー。

ValueStringvalue1

タグの値。

TargetSelectionStringSPECIFIC

更新バッチの範囲。有効な値:

  • ALL: すべてのデバイスを更新します。
  • SPECIFIC: 指定されたデバイスを更新します。
  • GRAY: 段階的更新を実行します。
説明 CreateOTADynamicUpgradeJob API 操作を呼び出して更新バッチを作成した場合、値 ALL が返されます。
TimeoutInMinutesInteger5

デバイス更新のタイムアウト期間。単位:分。

このパラメーターは、更新バッチの作成時にタイムアウト期間が設定されている場合に返されます。

UtcCreateString2019-12-28T02:43:10.000Z

更新バッチが作成された時刻。時刻は UTC で表示されます。

UtcEndTimeString2019-12-29T02:43:10.000Z

更新バッチの終了時刻。時刻は UTC で表示されます。

このパラメーターは、更新バッチが完了した後にのみ返されます。

UtcModifiedString2019-12-28T02:43:10.000Z

更新バッチが最後に変更された時刻。時刻は UTC で表示されます。

UtcScheduleFinishTimeString2019-12-30T02:43:10.000Z

スケジュールされた更新バッチの終了時刻。このパラメーターは、更新バッチがスケジュールされていて、スケジュールされた更新バッチの終了時刻が指定されている場合にのみ返されます。

UtcScheduleTimeString2019-12-29T02:43:10.000Z

スケジュールされた更新バッチの開始時刻。このパラメーターは、スケジュールされた更新バッチに対してのみ返されます。

UtcStartTimeString2019-12-28T02:43:10.000Z

更新バッチの開始時刻。時刻は UTC で表示されます。

ErrorMessageStringA system exception occurred.

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

RequestIdString30F1BB8D-EDBF-44FD-BBC0-BE97DEA73991

リクエストの ID。

SuccessBooleantrue

呼び出しが成功したかどうかを示します。

  • true: 呼び出しは成功しました。
  • false: 呼び出しは失敗しました。

リクエストの例

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 エラーセンターをご覧ください。