デバイスの未完了の更新タスクをクエリします。
QPS 制限
この操作は、アカウントごとに 1 秒あたり最大 10 回呼び出すことができます。
説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。
デバッグ
リクエストパラメーター
|
パラメーター |
タイプ |
必須 |
例 |
説明 |
| Action | String | Yes | ListOTAUnfinishedTaskByDevice | 実行する操作。値を ListOTAUnfinishedTaskByDevice に設定します。 |
| IotInstanceId | String | No | iot-c3j*** | インスタンスの ID。IoT Platform コンソールの [概要] タブでインスタンスの ID を取得できます。 重要
インスタンスの詳細については、「概要」をご参照ください。 |
| ModuleName | String | No | WifiConfigModify | OTA モジュールの名前。
|
| TaskStatusList.N | RepeatList | No | QUEUED | クエリする更新タスクのステータス。
説明 ListOTAUnfinishedTaskByDevice 操作を呼び出すときは、TaskStatusList.N に複数のステータスを指定できます。TaskStatusList.N または TaskStatus を設定する必要があります。 |
| ProductKey | String | No | a19mzPZ**** | デバイスが属するプロダクトの ProductKey。 重要 このパラメーターに値を指定する場合は、DeviceName も設定する必要があります。
|
| DeviceName | String | No | light | デバイスの DeviceName。 重要 このパラメーターを設定する場合は、ProductKey に値を指定する必要があります。
|
| TaskStatus | String | No | CONFIRM | クエリする更新タスクのステータス。
説明 ListOTAUnfinishedTaskByDevice 操作を呼び出すときは、TaskStatus には 1 つのステータスのみを指定できます。TaskStatusList または TaskStatus を設定する必要があります。 |
| IotId | String | No | TfmUAeJjQQhCPH84UVNn0010c6**** | デバイスの ID。 重要 このパラメーターに値を指定する場合は、ProductKey または DeviceName を設定する必要はありません。 IotId パラメーターは、デバイスのグローバル一意識別子 ( GUID ) を指定します。これは、ProductKey と DeviceName の値の組み合わせに対応します。 IotId、ProductKey、DeviceName に値を指定した場合、IotId の値が優先されます。
|
上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを設定する必要があります。共通のリクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。
レスポンスパラメーター
パラメーター |
タイプ |
例 |
説明 |
| Code | String | iot.system.SystemException | 呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。 |
| Data | SimpleOTATaskInfo の配列 | 呼び出しが成功した場合に返される更新タスクに関する情報。詳細については、SimpleOTATaskInfo をご参照ください。 |
|
| SimpleOTATaskInfo | |||
| DestVersion | String | 1.0.1 | 更新後のファームウェアのバージョン番号。 |
| DeviceName | String | light | デバイスの DeviceName。 |
| FirmwareId | String | q3j9OYBjUAZMv1hlMgdo03**** | 更新パッケージの ID。 |
| IotId | String | nadRdeffljdEndlfadgadfse**** | IoT Platform によって発行されたデバイスの一意の ID。デバイスの ID。この ID は、IoT Platform がデバイスに発行する一意の識別子です。 |
| JobId | String | 7glPHmaDYLAYMD1HHutT02**** | 更新バッチの ID。 |
| ModuleName | String | WifiConfigModify | OTA モジュールの名前。 |
| ProductKey | String | a1GUfrM**** | デバイスが属するプロダクトの ProductKey。 |
| ProductName | String | MyProduct | デバイスが属するプロダクトの名前。 |
| SrcVersion | String | 1.0.0 | 更新前のファームウェアバージョン。 |
| TaskId | String | y3tOmCDNgpR8F9jnVEzC01**** | 更新タスクの ID。 |
| TaskStatus | String | CONFIRM | 更新タスクのステータス。
|
| UtcCreate | String | 2019-11-04T03:38:22.000Z | 更新タスクが作成された時刻。時刻は UTC で表示されます。 |
| UtcModified | String | 2021-11-04T03:38:22.000Z | 更新タスクが最後に変更された時刻。時刻は UTC で表示されます。 |
| ErrorMessage | String | システム例外が発生しました。 | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
| RequestId | String | A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B | リクエストの ID。 |
| Success | Boolean | true | リクエストが成功したかどうかを示します。有効な値：
|
例
リクエストの例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListOTAUnfinishedTaskByDevice
&ProductKey=a19mzPZ****
&DeviceName=light
&TaskStatus=CONFIRM
&<共通リクエストパラメーター>成功レスポンスの例
XML 形式
<ListOTAUnfinishedTaskByDevice>
<Data>
<SimpleOTATaskInfo>
<SrcVersion>1.0.0</SrcVersion>
<DeviceName>testDevice1</DeviceName>
<FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
<IotId>SR8FiTu1R9tlUR2V1bmi00105****</IotId>
<ProductKey>a1GUfrM****</ProductKey>
<JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
<DestVersion>1.0.1</DestVersion>
<UtcCreate>2019-11-04T03:38:15.000Z</UtcCreate>
<UtcModified>2019-11-04T03:38:15.000Z</UtcModified>
<TaskStatus>QUEUED</TaskStatus>
<ProductName>MyProduct</ProductName>
<TaskId>y3tOmCDNgpR8F9jnVEzC01****</TaskId>
<ModuleName>WifiConfigModify</ModuleName>
</SimpleOTATaskInfo>
<SimpleOTATaskInfo>
<SrcVersion>1.0.0</SrcVersion>
<DeviceName>testDevice2</DeviceName>
<FirmwareId>q3j9OYBjUAZMv1hlMgdo03****</FirmwareId>
<IotId>nadRdeffljdEndlfadgadfse****</IotId>
<ProductKey>a1GUfrM****</ProductKey>
<JobId>7glPHmaDYLAYMD1HHutT02****</JobId>
<DestVersion>1.0.1</DestVersion>
<UtcCreate>2019-11-04T03:38:22.000Z</UtcCreate>
<UtcModified>2019-11-04T03:38:22.000Z</UtcModified>
<TaskStatus>CONFIRM</TaskStatus>
<ProductName>MyProduct</ProductName>
<TaskId>ZS9sNBb1ahsu6khqr9II01****</TaskId>
<ModuleName>ConfigModify</ModuleName>
</SimpleOTATaskInfo>
</Data>
<RequestId>A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B</RequestId>
<Success>true</Success>
</ListOTAUnfinishedTaskByDevice>JSON 形式
{
"Data": {
"SimpleOTATaskInfo": [{
"SrcVersion": "1.0.0",
"DeviceName": "testDevice1",
"FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
"IotId": "SR8FiTu1R9tlUR2V1bmi00105****",
"ProductKey": "a1GUfrM****",
"JobId": "7glPHmaDYLAYMD1HHutT02****",
"DestVersion": "1.0.1",
"UtcCreate": "2019-11-04T03:38:15.000Z",
"UtcModified": "2019-11-04T03:38:15.000Z",
"TaskStatus": "QUEUED",
"ProductName": "MyProduct",
"TaskId": "y3tOmCDNgpR8F9jnVEzC01****",
"ModuleName": "WifiConfigModify"
}, {
"SrcVersion": "1.0.0",
"DeviceName": "testDevice2",
"FirmwareId": "q3j9OYBjUAZMv1hlMgdo03****",
"IotId": "nadRdeffljdEndlfadgadfse****",
"ProductKey": "a1GUfrM****",
"JobId": "7glPHmaDYLAYMD1HHutT02****",
"DestVersion": "1.0.1",
"UtcCreate": "2019-11-04T03:38:22.000Z",
"UtcModified": "2019-11-04T03:38:22.000Z",
"TaskStatus": "CONFIRM",
"ProductName": "MyProduct",
"TaskId": "ZS9sNBb1ahsu6khqr9II01****",
"ModuleName": "ConfigModify"
}]
},
"RequestId": "A59D3BE1-E9A3-43F3-9B50-B7C8DE165D9B",
"Success": true
}エラーコード
|
HttpCode |
エラーコード |
エラーメッセージ |
説明 |
| 400 | iot.common.InvalidPageParams | 指定されたページサイズまたはページングパラメーターが無効です。 | 指定されたページサイズまたはページ番号が無効です。 |
| 400 | iot.ota.NullOtaModuleName | モジュール名を空にすることはできません。 | モジュールに名前が指定されていません。 |
| 400 | iot.ota.InvalidOtaModuleName | モジュール名の形式が無効です。 | モジュール名が無効です。 |
| 400 | iot.firmware.InvalidTaskStatus | 無効な TaskStatus です。 | バッチステータスが無効です。 |
| 400 | iot.device.InvalidFormattedDeviceNameInNameArray | DeviceName リストに無効なデバイス名が含まれています。 | DeviceName リストに無効な DeviceName が存在します。 |
| 400 | iot.firmware.ListOTATaskByDeviceFailed | デバイスごとの OTA タスクのリスト取得に失敗しました。 | システムはデバイスの更新タスクを取得できませんでした。 |
| 400 | iot.prod.NotExistedProduct | 指定されたプロダクトは存在しません。 | 指定されたプロダクトは存在しません。 |
エラーコードの一覧については、「サービスエラーコード」をご参照ください。