プロダクトのデバイスをクエリします。
説明
QueryDevice 操作は、操作を呼び出すたびに最大 100 万台のデバイスを返すことができます。
QPS 制限
- この API 操作は、アカウントごとに 1 秒あたり最大 50 回呼び出すことができます。説明 Alibaba Cloud アカウントの RAM ユーザーは、Alibaba Cloud アカウントのクォータを共有します。
[CurrentPage] パラメーターの値と [PageSize] パラメーターの値の積が 100,000 以上の場合、この操作のクエリ/秒 (QPS) は減少します。
この場合、この API 操作は、アカウントごとに 1 秒あたり最大 2 回呼び出すことができます。
デバッグ
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| Action | String | はい | QueryDevice | 実行する操作。値を QueryDevice に設定します。 |
| ProductKey | String | はい | a1BwAGV**** | デバイスが属するプロダクトの ProductKey。 |
| IotInstanceId | String | いいえ | iot_instc_pu****_c*-v64******** | インスタンスの ID。IoT Platform コンソールの [概要] ページでインスタンスの [ID] を表示できます。 重要
詳細については、「概要」をご参照ください。 |
| PageSize | Integer | いいえ | 10 | 各ページに返すエントリの数。有効な値:1 ~ 50。デフォルト値:10。 |
| CurrentPage | Integer | いいえ | 1 | 返すページの番号。デフォルト値:1。 |
| NextToken | String | いいえ | TGlzdFJlc291cm*** | クエリ結果の次のページを取得するために使用されるトークン。クエリ操作を初めて実行するときは、このパラメーターを設定する必要はありません。 [NextToken] パラメーターには、前のクエリから取得したトークンを指定する必要があります。 [PageSize] パラメーターの値と [CurrentPage] パラメーターの値の積が 10,000 を超える場合は、[NextToken] パラメーターを設定する必要があります。設定しないと、データは返されません。 重要 [NextToken] パラメーターを設定する場合、[PageSize] パラメーターの値と [CurrentPage] パラメーターの値の積は 1,000,000 未満である必要があります。そうでない場合、データは返されません。 |
上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを設定する必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| Code | String | iot.system.SystemException | 呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。 |
| Data | DeviceInfo の配列 | 呼び出しが成功した場合に返されるデバイス情報。デバイスの詳細は、[DeviceInfo] パラメーターに含まれています。 説明 返されるデバイス情報は、デバイスが作成された時刻に基づいて、逆時系列順にソートされます。 | |
| DeviceInfo | |||
| DeviceId | String | dwnS41bhNxjslDAI**** | デバイスの ID。 説明 このパラメーターは非推奨です。デバイスの識別にこのパラメーターを使用しないでください。 [IotId] パラメーター、または [ProductKey] パラメーターと [DeviceName] パラメーターの組み合わせを使用して、デバイスを識別できます。 |
| DeviceName | String | light | デバイスの名前。 |
| DeviceSecret | String | sLefbFmN9SYfnWLJTePG893XNuRV**** | デバイスの DeviceSecret。 |
| DeviceStatus | String | ONLINE | デバイスのステータス。有効な値:
|
| DeviceType | String | Lighting | デバイスが属するプロダクトのカテゴリ。 説明 このパラメーターは返されません。 |
| GmtCreate | String | Wed, 20-Feb-2019 02:16:09 GMT | デバイスが作成された時刻。時刻は GMT 形式です。 |
| GmtModified | String | Wed, 20-Feb-2019 02:16:09 GMT | デバイス情報が最後に更新された時刻。時刻は GMT 形式です。 |
| IotId | String | Q7uOhVRdZRRlDnTLv****00100 | デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。 |
| Nickname | String | Smart light | デバイスのエイリアス。 |
| ProductKey | String | a1BwAGV**** | デバイスが属するプロダクトの ProductKey。 |
| UtcCreate | String | 2019-02-20T02:16:09.000Z | デバイスが作成された時刻。時刻は UTC で表示されます。 |
| UtcModified | String | 2019-02-20T02:16:09.000Z | デバイス情報が最後に更新された時刻。時刻は UTC で表示されます。 |
| ErrorMessage | String | A system exception occurred. | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
| NextToken | String | TGlzdFJlc291cm*** | クエリ結果の次のページを取得するために使用されるトークン。後続のクエリでこのパラメーターを指定して、次の結果ページを取得できます。 [NextToken] パラメーターが空の場合、後続のページは存在しません。 |
| Page | Integer | 1 | 返されたページのページ番号。 |
| PageCount | Integer | 1 | 返されるページの総数。 |
| PageSize | Integer | 10 | 1 ページあたりに返されるエントリの数。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | リクエストの ID。 |
| Success | Boolean | true | 呼び出しが成功したかどうかを示します。有効な値:
|
| Total | Integer | 2 | デバイスの総数。 |
例
リクエストの例
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDevice
&ProductKey=aldafD****
&PageSize=10
&CurrentPage=1
&<共通リクエストパラメーター>成功レスポンスの例
XML 形式
<QueryDeviceResponse>
<PageCount>1</PageCount>
<NextToken>TGlzdFJlc291cm***</NextToken>
<Data>
<DeviceInfo>
<DeviceId>Av8NGHGtwPrH9BYG****</DeviceId>
<DeviceName>Av8NGHGtwPrH9BYGLMBi</DeviceName>
<ProductKey>a1dafDE****</ProductKey>
<DeviceSecret>d7GYhf5hfcPHDe1bXSd3n9MjO1G3****</DeviceSecret>
<UtcModified>2019-02-20T02:16:09.000Z</UtcModified>
<GmtCreate>Wed, 20-Feb-2019 02:16:09 GMT</GmtCreate>
<UtcCreate>2019-02-20T02:16:09.000Z</UtcCreate>
<GmtModified>Wed, 20-Feb-2019 02:16:09 GMT</GmtModified>
<IotId>Av8NGHGtwPrH9BYGLMBi00****</IotId>
<DeviceStatus>UNACTIVE</DeviceStatus>
<Nickname>SensorInShanghai</Nickname>
</DeviceInfo>
<DeviceInfo>
<DeviceId>zNIcSmWQ9BPJlmkj****</DeviceId>
<DeviceName>zNIcSmWQ9BPJlmkjn3H1</DeviceName>
<ProductKey>a1dafDE****</ProductKey>
<DeviceSecret>C27XXmC18yLIEDXvUj6FSlvgO7ag****</DeviceSecret>
<UtcModified>2019-02-20T02:16:09.000Z</UtcModified>
<GmtCreate>Wed, 20-Feb-2019 02:16:09 GMT</GmtCreate>
<UtcCreate>2019-02-20T02:16:09.000Z</UtcCreate>
<GmtModified>Wed, 20-Feb-2019 02:16:09 GMT</GmtModified>
<IotId>zNIcSmWQ9BPJlmkjn3H100****</IotId>
<DeviceStatus>UNACTIVE</DeviceStatus>
<Nickname>DriverInShanghai</Nickname>
</DeviceInfo>
</Data>
<Page>1</Page>
<PageSize>10</PageSize>
<RequestId>CD9E5F99-A095-4A05-9256-D924EA3075E8</RequestId>
<Success>true</Success>
<Total>2</Total>
</QueryDeviceResponse>JSON 形式
{
"PageCount": 1,
"NextToken":"TGlzdFJlc291cm***",
"Data": {
"DeviceInfo": [
{
"DeviceId": "Av8NGHGtwPrH9BYG****",
"DeviceName": "Av8NGHGtwPrH9BYGLMBi",
"ProductKey": "a1dafDE****",
"DeviceSecret": "d7GYhf5hfcPHDe1bXSd3n9MjO1G3****",
"UtcModified": "2019-02-20T02:16:09.000Z",
"GmtCreate": "Wed, 20-Feb-2019 02:16:09 GMT",
"UtcCreate": "2019-02-20T02:16:09.000Z",
"GmtModified": "Wed, 20-Feb-2019 02:16:09 GMT",
"IotId": "Av8NGHGtwPrH9BYGLMBi00****",
"DeviceStatus": "UNACTIVE",
"Nickname": "SensorInShanghai"
},
{
"DeviceId": "zNIcSmWQ9BPJlmkj****",
"DeviceName": "zNIcSmWQ9BPJlmkjn3H1",
"ProductKey": "a1dafDE****",
"DeviceSecret": "C27XXmC18yLIEDXvUj6FSlvgO7ag****",
"UtcModified": "2019-02-20T02:16:09.000Z",
"GmtCreate": "Wed, 20-Feb-2019 02:16:09 GMT",
"UtcCreate": "2019-02-20T02:16:09.000Z",
"GmtModified": "Wed, 20-Feb-2019 02:16:09 GMT",
"IotId": "zNIcSmWQ9BPJlmkjn3H100****",
"DeviceStatus": "UNACTIVE",
"Nickname": "DriverInShanghai"
}
]
},
"Page": 1,
"PageSize": 10,
"RequestId": "CD9E5F99-A095-4A05-9256-D924EA3075E8",
"Success": true,
"Total": 2
}エラーコード
エラーコードのリストについては、「サービスエラーコード」をご参照ください。