調用該接口查詢批量注冊的設備信息。
QPS限制
單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為50。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryPageByApplyId |
系統規定參數。取值:QueryPageByApplyId。 |
ApplyId | Long | 是 | 1295006 |
要查詢的申請批次ID。申請批次ID可在BatchRegisterDeviceWithApplyId和BatchRegisterDevice接口返回結果中查看。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** |
實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID。 注意
實例的更多信息,請參見實例概述。 |
PageSize | Integer | 否 | 10 |
指定返回結果中每頁顯示的記錄數量。數量限制:每頁最多可顯示50條。默認值是10。 |
CurrentPage | Integer | 否 | 1 |
指定從返回結果中的第幾頁開始顯示。默認值是1。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
ApplyDeviceList | Array of ApplyDeviceInfo |
調用成功時,生成的已注冊的設備列表(ApplyDeviceInfo)。 |
|
ApplyDeviceInfo | |||
DeviceId | String | gQG2GJ2y10m6hIk8**** |
設備ID(舊版參數)。 說明 該參數是舊版本遺留參數,已無實際作用,不能用來標識設備。目前有效的設備標識符為IotId和ProductKey與DeviceName組合。
|
DeviceName | String | light |
設備名稱。 |
DeviceSecret | String | SkfeXXKrTgp1DbDxYr74mfJ5cnui**** |
設備密鑰。 |
IotId | String | vWxNur6BUApsqjv9****000100 |
設備ID,物聯網平臺為該設備頒發的唯一標識符。 |
Code | String | iot.system.SystemException |
調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
ErrorMessage | String | 系統異常 |
調用失敗時,返回的出錯信息。 |
Page | Integer | 1 |
當前頁面號。 |
PageCount | Integer | 1 |
總頁數。 |
PageSize | Integer | 10 |
每頁顯示的設備數。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true |
表示是否調用成功。
|
Total | Integer | 2 |
該批次的設備總數。 |
示例
請求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryPageByApplyId
&ApplyId=1234567
&PageSize=10
&CurrentPage=1
&<公共請求參數>
正常返回示例
XML
格式
<QueryPageByApplyIdResponse>
<PageCount>1</PageCount>
<ApplyDeviceList>
<ApplyDeviceInfo>
<DeviceId>vWxNur6BUApsqjv9****</DeviceId>
<DeviceName>APItest</DeviceName>
<DeviceSecret>tXXEtily4XuV7WS1fosJoDkhRIIU****</DeviceSecret>
<IotId>vWxNur6BUApsqjv****4000100</IotId>
</ApplyDeviceInfo>
<ApplyDeviceInfo>
<DeviceId>hoiwszKPYmHk074H****</DeviceId>
<DeviceName>awfg</DeviceName>
<DeviceSecret>BYpg1b2nmuq21BO7fxOogYQQZd9z****</DeviceSecret>
<IotId>hoiwszKPYmHk074HA****000100</IotId>
</ApplyDeviceInfo>
</ApplyDeviceList>
<Page>1</Page>
<PageSize>10</PageSize>
<RequestId>762F7AAD-8B87-4C65-BBF3-4575B002B384</RequestId>
<Success>true</Success>
<Total>2</Total>
</QueryPageByApplyIdResponse>
JSON
格式
{
"PageCount": 1,
"ApplyDeviceList": {
"ApplyDeviceInfo": [
{
"DeviceId": "vWxNur6BUApsqjv9****",
"DeviceName": "APItest",
"DeviceSecret": "tXXEtily4XuV7WS1fosJoDkhRIIU****",
"IotId": "vWxNur6BUApsqjv****4000100"
},
{
"DeviceId": "hoiwszKPYmHk074H****",
"DeviceName": "awfg",
"DeviceSecret": "BYpg1b2nmuq21BO7fxOogYQQZd9z****",
"IotId": "hoiwszKPYmHk074HA****000100"
}
]
},
"Page": 1,
"PageSize": 10,
"RequestId": "762F7AAD-8B87-4C65-BBF3-4575B002B384",
"Success": true,
"Total": 2
}