更新パッケージの更新バッチを照会します。
制限
各 Alibaba Cloud アカウントは、最大 10 クエリ/秒(QPS)を実行できます。
デバッグ
リクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
Action | String | はい | ListOTAJobByFirmware | 実行する操作。値を ListOTAJobByFirmware に設定します。 |
CurrentPage | Integer | はい | 1 | 返すページ番号。ページは 1 ページ目から始まります。 |
FirmwareId | String | はい | FJFx8JzpnhpIsKftRjjm03**** | 更新パッケージの ID。 CreateOTAFirmware 操作を呼び出して更新パッケージを作成すると、更新パッケージ ID が返されます。 ListOTAFirmware 操作を呼び出して、レスポンスで更新パッケージ ID を表示できます。 |
PageSize | Integer | はい | 10 | 各ページに返すエントリの数。最大値:200。 |
IotInstanceId | String | いいえ | iot-cn-0pp1n8t**** | インスタンスの ID。IoT Platform コンソール の [概要] ページでインスタンスの [ID] を表示できます。 重要
詳細については、「概要」をご参照ください。 |
上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを指定する必要があります。詳細については、「共通リクエストパラメーター」をご参照ください。
レスポンスパラメーター
パラメーター | タイプ | 例 | 説明 |
Code | String | iot.system.SystemException | 呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。 |
CurrentPage | Integer | 1 | 返されたページ番号。 |
Data | SimpleOTAJobInfo の配列 | 呼び出しが成功した場合に返される更新バッチ情報。詳細については、SimpleOTATaskInfo をご参照ください。 | |
SimpleOTAJobInfo | |||
FirmwareId | String | UfuxnwygsuSkVE0VCN****0100 | 更新パッケージの ID。 |
JobId | String | HvKuBpuk3rdk6E92CP****0200 | 更新バッチの ID。 |
JobStatus | String | IN_PROGRESS | 更新バッチのステータス。
|
JobType | String | UPGRADE_FIRMWARE | バッチのタイプ。有効な値:
|
ProductKey | String | a19mzPZ**** | 更新パッケージが属するプロダクトの ProductKey。 |
SelectionType | String | STATIC | 更新バッチの更新ポリシー。有効な値:
|
Tags | OtaTagDTO の配列 | 更新バッチのタグ。 | |
OtaTagDTO | |||
Key | String | key1 | 各タグのキー。 |
Value | String | value1 | タグの値。 |
TargetSelection | String | SPECIFIC | 更新バッチの範囲。有効な値:
説明 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-28T02:43:10.000Z | 更新バッチが最後に変更された時刻。時刻は UTC で表示されます。 |
UtcStartTime | String | 2019-12-28T02:43:10.000Z | 更新バッチの開始時刻。時刻は UTC で表示されます。 |
ErrorMessage | String | システム例外が発生しました。 | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
PageCount | Integer | 1 | ページの総数。 |
PageSize | Integer | 10 | 1 ページあたりに返されるエントリの数。 |
RequestId | String | 5D58AC86-D5BF-4B39-834E-913E7F2C985D | リクエストの ID。 |
Success | Boolean | true | 呼び出しが成功したかどうかを示します。
|
Total | Integer | 1 | 返された更新ジョブの総数。 |
例
リクエストの例
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 エラーセンター をご参照ください。