更新バッチ別にデバイスの更新タスクをクエリします。
QPS 制限
Alibaba Cloud アカウントごとに、最大 10 クエリ/秒（QPS）を実行できます。
デバッグ
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| Action | String | Yes | ListOTATaskByJob | 実行する操作。値を ListOTATaskByJob に設定します。 |
| JobId | String | Yes | 7glPHmaDYLAYMD1HHutT02**** | 更新バッチの ID。この ID は、更新バッチを一意に識別します。 ジョブ IDCreateOTAVerifyJob、CreateOTAStaticUpgradeJob、または CreateOTADynamicUpgradeJob 操作を呼び出した後に返される JobId パラメーターの値から ID を取得できます。また、IoT Platform コンソールの ページでバッチ ID を表示することもできます。 |
| IotInstanceId | String | No | iot_instc_pu****_c*-v64******** | インスタンスの ID。IoT Platform コンソールの 概要 ページでインスタンスの ID を表示できます。 重要
詳細については、「概要」をご参照ください。 |
| PageSize | Integer | No | 10 | 各ページに返すエントリの数。最大値：100。 重要 CurrentPage パラメーターの値と PageSize パラメーターの値の積は、100,000 以下である必要があります。 |
| TaskStatus | String | No | FAILED | このパラメーターに値を指定すると、指定された状態の更新タスクのみがクエリされます。有効な値：
このパラメーターに値を指定しない場合は、指定されたバッチのすべての更新タスクがクエリされます。 |
| CurrentPage | Integer | No | 1 | 返すページの番号。ページは 1 ページ目から始まります。 重要 CurrentPage パラメーターの値と PageSize パラメーターの値の積は、100,000 以下である必要があります。 |
| DeviceNames.N | RepeatList | No | device1 | クエリするデバイスの名前。 説明
|
上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを設定する必要があります。 詳細については、「共通リクエストパラメーター」をご参照ください。
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| Code | String | iot.system.SystemException | 呼び出しが失敗した場合に返されるエラーコード。 詳細については、「エラーコード」をご参照ください。 |
| CurrentPage | Integer | 1 | 返されたページの番号。 |
| Data | SimpleOTATaskInfo の配列 | 呼び出しが成功した場合に返される更新タスク情報。 詳細については、SimpleOTATaskInfo をご参照ください。 |
|
| SimpleOTATaskInfo | |||
| DestVersion | String | 1.0.1 | 宛先無線 (OTA) 更新パッケージのバージョン。 |
| DeviceName | String | testDevice2 | デバイスの名前。 |
| FirmwareId | String | q3j9OYBjUAZMv1hlMgdo03**** | 更新パッケージの ID。 |
| IotId | String | nadRdeffljdEndlfadgadfse**** | デバイスの ID。 |
| JobId | String | 7glPHmaDYLAYMD1HHutT02**** | 更新バッチの ID。 |
| ProductKey | String | a1GUfrM**** | デバイスが属するプロダクトの ProductKey。 |
| ProductName | String | MyProduct | デバイスが属するプロダクトの名前。 |
| Progress | String | 0.00 | 現在の更新の進捗状況。 |
| SrcVersion | String | 1.0.0 | 更新前のファームウェアバージョン。 |
| TaskDesc | String | report version is not conform | 更新タスクの説明。デバイスの更新がタイムアウトした場合、または更新タスクがキャンセルされた場合、このパラメーターにはエラーメッセージが表示されます。 |
| TaskId | String | y3tOmCDNgpR8F9jnVEzC01**** | 更新タスクの ID。 |
| TaskStatus | String | FAILED | デバイスの更新ステータス。
|
| Timeout | String | 1440 | デバイス更新のタイムアウト期間。単位：分。 説明 更新バッチにタイムアウト期間が指定されていない場合、戻り値は null です。 |
| UtcCreate | String | 2019-11-04T03:38:22.000Z | 更新タスクが作成された時刻。時刻は UTC で表示されます。 |
| UtcModified | String | 2019-11-04T03:38:22.000Z | 更新タスクが最後に変更された時刻。時刻は UTC で表示されます。 |
| ErrorMessage | String | A system exception occurred. | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
| PageCount | Integer | 1 | 返されるページの総数。 |
| PageSize | Integer | 10 | ページごとに返されるエントリの数。 |
| RequestId | String | A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B | リクエストの ID。 |
| Success | Boolean | true | 呼び出しが成功したかどうかを示します。
|
| Total | Integer | 2 | 更新タスクの総数。 |
例
リクエストの例
https://iot.cn-shanghai.aliyuncs.com/?Action=ListOTATaskByJob
&JobId=7glPHmaDYLAYMD1HHutT02****
&PageSize=10
&CurrentPage=1
&<共通リクエストパラメーター>成功レスポンスの例
XML 形式
<ListOTATaskByJobResponse>
<PageCount>1</PageCount>
<Data>
<SimpleOTATaskInfo>
<SrcVersion>1.0.0</SrcVersion>
<DeviceName>testDevice1</DeviceName>
<FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
<IotId>SR8FiTu1R9tlUR2V1bmi00105****</IotId>
<ProductKey>a1GUfrM****</ProductKey>
<JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
<TaskDesc>report version is not conform</TaskDesc>
<DestVersion>1.0.1</DestVersion>
<Timeout>1440</Timeout>
<UtcCreate>2019-11-04T03:38:15.000Z</UtcCreate>
<UtcModified>2019-11-04T03:38:15.000Z</UtcModified>
<TaskStatus>FAILED</TaskStatus>
<ProductName>MyProduct</ProductName>
<TaskId>y3tOmCDNgpR8F9jnVEzC01****</TaskId>
<Progress>0.00</Progress>
</SimpleOTATaskInfo>
<SimpleOTATaskInfo>
<SrcVersion>1.0.0</SrcVersion>
<DeviceName>testDevice2</DeviceName>
<FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
<IotId>nadRdeffljdEndlfadgadfse****</IotId>
<ProductKey>a1GUfrM****</ProductKey>
<JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
<TaskDesc></TaskDesc>
<DestVersion>1.0.1</DestVersion>
<Timeout>1000</Timeout>
<UtcCreate>2019-11-04T03:38:22.000Z</UtcCreate>
<UtcModified>2019-11-04T03:38:22.000Z</UtcModified>
<TaskStatus>SUCCEEDED</TaskStatus>
<ProductName>MyProduct</ProductName>
<TaskId>ZS9sNBb1ahsu6khqr9II01****</TaskId>
<Progress>100.00</Progress>
</SimpleOTATaskInfo>
</Data>
<PageSize>10</PageSize>
<RequestId>A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B</RequestId>
<CurrentPage>1</CurrentPage>
<Success>true</Success>
<Total>2</Total>
</ListOTATaskByJobResponse>JSON 形式
{
"PageCount": 1,
"Data": {
"SimpleOTATaskInfo": [{
"SrcVersion": "1.0.0",
"DeviceName": "testDevice1",
"FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
"IotId": "SR8FiTu1R9tlUR2V1bmi00105****",
"ProductKey": "a1GUfrM****",
"JobId": "7glPHmaDYLAYMD1HHutT02****",
"TaskDesc": "report version is not conform",
"DestVersion": "1.0.1",
"Timeout":"1440",
"UtcCreate": "2019-11-04T03:38:15.000Z",
"UtcModified": "2019-11-04T03:38:15.000Z",
"TaskStatus": "FAILED",
"ProductName": "MyProduct",
"TaskId": "y3tOmCDNgpR8F9jnVEzC01****",
"Progress": "0.00"
}, {
"SrcVersion": "1.0.0",
"DeviceName": "testDevice2",
"FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
"IotId": "nadRdeffljdEndlfadgadfse****",
"ProductKey": "a1GUfrM****",
"JobId": "7glPHmaDYLAYMD1HHutT02****",
"TaskDesc": "",
"DestVersion": "1.0.1",
"Timeout":"1000",
"UtcCreate": "2019-11-04T03:38:22.000Z",
"UtcModified": "2019-11-04T03:38:22.000Z",
"TaskStatus": "SUCCEEDED",
"ProductName": "MyProduct",
"TaskId": "ZS9sNBb1ahsu6khqr9II01****",
"Progress": "100.00"
}]
},
"PageSize": 10,
"RequestId": "A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B",
"CurrentPage": 1,
"Success": true,
"Total": 2
}エラーコード
エラーコードのリストについては、API エラーセンターを参照してください。