調用該介面查詢大量註冊的裝置資訊。
QPS限制
單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為50。
說明 RAM使用者共用阿里雲帳號配額。
調試
您可以在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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。