ListOTAJobByDevice - IoT Platform - Alibaba Cloud ドキュメントセンター

更新パッケージ別にデバイスのすべての更新バッチをクエリします。

制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	ListOTAJobByDevice	実行する操作。値を ListOTAJobByDevice に設定します。
CurrentPage	Integer	はい	1	返すページ番号。ページは 1 ページ目から始まります。
DeviceName	String	はい	light1	デバイスの DeviceName。
FirmwareId	String	はい	FJFx8JzpnhpIsKftRjjm03****	更新パッケージの ID。ID は、更新パッケージの一意の識別子です。 CreateOTAFirmware 操作を呼び出して更新パッケージを作成すると、更新パッケージ ID が返されます。 ListOTAFirmware 操作を呼び出して、レスポンスで更新パッケージ ID を表示できます。
PageSize	Integer	はい	10	各ページに返すエントリの数。最大値：100。
ProductKey	String	はい	a19mzPZ****	デバイスが属するプロダクトの ProductKey。
IotInstanceId	String	いいえ	iot-cn-0pp1n8t****	インスタンスの ID。 IoT Platform コンソールの [概要] ページでインスタンスの [ID] を表示できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	MissingFirmwareId	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
CurrentPage	Integer	1	返されたページ番号。
Data	SimpleOTAJobInfo の配列		呼び出しが成功した場合に返される更新バッチ情報。詳細については、以下の SimpleOTAJobInfo パラメーターをご参照ください。
SimpleOTAJobInfo
FirmwareId	String	FJFx8JzpnhpIsKftRjjm03****	更新パッケージの ID。
JobId	String	HvKuBpuk3rdk6E92CP****	更新バッチの ID。
JobStatus	String	COMPLETED	更新バッチのステータス。有効な値： IN_PROGRESS: 更新バッチは実行中です。 COMPLETE: 更新バッチは完了しました。 CANCELED: 更新バッチはキャンセルされました。
JobType	String	UPGRADE_FIRMWARE	タスクのタイプ。有効な値： VERFIY_FIRMWARE: 更新パッケージの検証。 UPGRADE_FIRMWARE: 一括更新。
ProductKey	String	a19mzPZ****	更新パッケージが属するプロダクトの ProductKey。
SelectionType	String	STATIC	更新バッチの更新ポリシー。有効な値： DYNAMIC: 動的更新。 CreateOTADynamicUpgradeJob API 操作を呼び出して更新バッチを作成した場合に返されます。 STATIC: 静的更新。 CreateOTAStaticUpgradeJob API 操作を呼び出して更新バッチを作成した場合に返されます。
Tags	OtaTagDTO の配列		更新バッチのタグ。
OtaTagDTO
Key	String	key1	各タグのキー。
Value	String	value1	タグの値。
TargetSelection	String	ALL	更新の範囲。有効な値： ALL: すべてのデバイスを更新します。 SPECIFIC: 指定されたデバイスを更新します。 GRAY: 段階的更新を実行します。説明 CreateOTADynamicUpgradeJob API 操作を呼び出して更新バッチを作成した場合、値 ALL が返されます。
UtcCreate	String	2019-12-28T02:43:10.000Z	更新バッチが作成された日時。時刻は UTC で表示されます。
UtcEndTime	String	2019-12-29T02:43:10.000Z	更新バッチの終了時刻。時刻は UTC で表示されます。説明このパラメーターは、更新バッチが完了した後にのみ返されます。
UtcModified	String	2019-12-29T02:43:10.000Z	タスクが最後に変更された日時。時刻は UTC です。
UtcStartTime	String	2019-12-29T02:43:10.000Z	更新バッチの開始時刻。時刻は UTC 形式です。
ErrorMessage	String	FirmwareId is mandatory for this action	呼び出しが失敗した場合に返されるエラーメッセージ。
PageCount	Integer	1	ページの総数。
PageSize	Integer	10	1 ページあたりに返されるエントリの数。
RequestId	String	A01829CE-75A1-4920-B775-921146A1AB79	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。
Total	Integer	1	返された更新パッケージの総数。

例

サンプルリクエスト

https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAJobByDevice
&FirmwareId=FJFx8JzpnhpIsKftRjjm03****
&ProductKey=a19mzPZ****
&DeviceName=light
&PageSize=10
&CurrentPage=1
&共通リクエストパラメーター

サンプルの成功レスポンス

XML 形式

<ListOTAJobByDeviceResponse>
  <PageCount>1</PageCount>
  <Data>
        <SimpleOTAJobInfo>
              <SelectionType>STATIC</SelectionType>
              <TargetSelection>SPECIFIC</TargetSelection>
              <JobType>UPGRADE_FIRMWARE</JobType>
              <FirmwareId>FJFx8JzpnhpIsKftRjjm03****</FirmwareId>
              <UtcStartTime>2019-12-28T02:43:10.000Z</UtcStartTime>
              <ProductKey>a19mzPZ****</ProductKey>
              <JobId>HvKuBpuk3rdk6E92CPQN02****</JobId>
              <UtcModified>2019-12-28T02:43:10.000Z</UtcModified>
              <JobStatus>IN_PROGRESS</JobStatus>
              <UtcCreate>2019-12-28T02:43:10.000Z</UtcCreate>
        </SimpleOTAJobInfo>
  </Data>
  <PageSize>10</PageSize>
  <RequestId>5D58AC86-D5BF-4B39-834E-913E7F2C985D</RequestId>
  <CurrentPage>1</CurrentPage>
  <Success>true</Success>
  <Total>1</Total>
</ListOTAJobByDeviceResponse>

JSON 形式

{
  "PageCount": 1,
  "Data": {
    "SimpleOTAJobInfo": [{
      "SelectionType": "STATIC",
      "TargetSelection": "SPECIFIC",
      "JobType": "UPGRADE_FIRMWARE",
      "FirmwareId": "FJFx8JzpnhpIsKftRjjm03****",
      "UtcStartTime": "2019-12-28T02:43:10.000Z",
      "ProductKey": "a19mzPZ****",
      "JobId": "HvKuBpuk3rdk6E92CPQN02****",
      "UtcModified": "2019-12-28T02:43:10.000Z",
      "JobStatus": "IN_PROGRESS",
      "UtcCreate": "2019-12-28T02:43:10.000Z"
    }]
  },
  "PageSize": 10,
  "RequestId": "5D58AC86-D5BF-4B39-834E-913E7F2C985D",
  "CurrentPage": 1,
  "Success": true,
  "Total": 1
}

エラーコード

エラーコードの一覧については、API エラーセンターをご参照ください。