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

IoT Platform:ListOTAJobByFirmware

最終更新日:Apr 17, 2025

更新パッケージの更新バッチを照会します。

制限

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

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

デバッグ

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

リクエストパラメーター

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

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

CurrentPageIntegerはい1

返すページ番号。ページは 1 ページ目から始まります。

FirmwareIdStringはいFJFx8JzpnhpIsKftRjjm03****

更新パッケージの ID。

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

ListOTAFirmware 操作を呼び出して、レスポンスで更新パッケージ ID を表示できます。

PageSizeIntegerはい10

各ページに返すエントリの数。最大値:200。

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

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

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

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

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

レスポンスパラメーター

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

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

CurrentPageInteger1

返されたページ番号。

DataSimpleOTAJobInfo の配列

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

SimpleOTAJobInfo
FirmwareIdStringUfuxnwygsuSkVE0VCN****0100

更新パッケージの ID。

JobIdStringHvKuBpuk3rdk6E92CP****0200

更新バッチの ID。

JobStatusStringIN_PROGRESS

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

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

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

  • VERFIY_FIRMWARE: 更新パッケージの検証。
  • UPGRADE_FIRMWARE: 一括更新。
ProductKeyStringa19mzPZ****

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

SelectionTypeStringSTATIC

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

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

更新バッチのタグ。

OtaTagDTO
KeyStringkey1

各タグのキー。

ValueStringvalue1

タグの値。

TargetSelectionStringSPECIFIC

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

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

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

UtcEndTimeString2019-12-29T02:43:10.000Z

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

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

UtcModifiedString2019-12-28T02:43:10.000Z

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

UtcStartTimeString2019-12-28T02:43:10.000Z

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

ErrorMessageStringシステム例外が発生しました。

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

PageCountInteger1

ページの総数。

PageSizeInteger10

1 ページあたりに返されるエントリの数。

RequestIdString5D58AC86-D5BF-4B39-834E-913E7F2C985D

リクエストの ID。

SuccessBooleantrue

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

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

返された更新ジョブの総数。

リクエストの例

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

成功レスポンスの例

XML 形式

<ListOTAJobByFirmwareResponse>
    <PageCount>1</PageCount>
    <Data>
        <SimpleOTAJobInfo>
            <SelectionType>STATIC</SelectionType>
            <TargetSelection>SPECIFIC</TargetSelection>
            <JobType>UPGRADE_FIRMWARE</JobType>
            <FirmwareId>yLYuCqfqQNQ1JOqkDa****0100</FirmwareId>
            <UtcStartTime>2019-12-28T02:43:10.000Z</UtcStartTime>
            <UtcEndTime>2019-12-29T02:43:10.000Z</UtcEndTime>
            <ProductKey>a19mzPZ****</ProductKey>
            <JobId>HvKuBpuk3rdk6E92CP****0200</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>
</ListOTAJobByFirmwareResponse>

JSON 形式

{
  "PageCount": 1,
  "Data": {
    "SimpleOTAJobInfo": [{
      "SelectionType": "STATIC",
      "TargetSelection": "SPECIFIC",
      "JobType": "UPGRADE_FIRMWARE",
      "FirmwareId": "UfuxnwygsuSkVE0VCN****0100",
      "UtcStartTime": "2019-12-28T02:43:10.000Z",
      "UtcEndTime": "2019-12-29T02:43:10.000Z",
      "ProductKey": "a19mzPZ****",
      "JobId": "HvKuBpuk3rdk6E92CP****0200",
      "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 エラーセンター をご参照ください。