調用該接口分頁查詢發現設備的列表。
路徑 | /awss/enrollee/list/get |
版本號 | 1.0.7 |
協議 | HTTP,HTTPS |
請求方法 | POST |
是否需要用戶身份鑒權 | 是 |
超時時間 | 3000 |
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
pageSize | Int | 是 | 10 | 分頁大小,取值范圍:1~20。 |
pageNum | Int | 是 | 1 | 分頁頁碼,從 1 開始。 |
groupId | String | 否 | 空間的ID。生活物聯網平臺賦予空間的唯一標識符。 | |
productStatusEnv | String | 否 | dev | 產品狀態。dev(表示產品開發中);release(表示產品已發布)。 |
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
totalNum | Int |
獲取到設備的總數。 |
|
items | JSON |
設備列表信息。 |
|
gmtCreate | Long |
發現設備的創建時間。 |
|
gmtModified | Long |
發現設備的修改時間。 |
|
regIotId | String |
已配網設備的設備ID,生活物聯網平臺為設備頒發的ID,設備的唯一標識符。 |
|
regProductKey | String |
已配網設備所屬產品的Key,設備證書信息之一。創建產品時,生活物聯網平臺為該產品頒發的全局唯一標識。 |
|
regDeviceName | String |
已配網設備的設備名稱。 |
|
regProductName | String |
已配網設備所屬產品的名稱。 |
|
enrolleeIotId | String |
待配網設備的設備ID,生活物聯網平臺為設備頒發的ID,設備的唯一標識符。 |
|
enrolleeProductKey | String |
待配網設備所屬產品的Key,設備證書信息之一。創建產品時,生活物聯網平臺為該產品頒發的全局唯一標識。 |
|
enrolleeDeviceName | String |
待配網設備的設備名稱。 |
|
enrolleeProductName | String |
待配網設備所屬產品的名稱。 |
|
bssid | String |
路由器BSSID。 |
|
ssid | String |
熱點SSID。 |
|
rssi | String |
熱點RSSI。 |
|
type | Int |
發現者設備類型,0(表示Device);1(表示Router)。 |
|
status | Int |
配網過程狀態,0(表示初始態); 1(表示配網中)。 |
示例
請求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.7",
"iotToken": "token"
},
"params":{
"pageSize":10,
"pageNum":1,
"groupId": "value2",
"productStatusEnv": "dev"
}
}
正常返回示例
JSON
格式
{
"code": 200,
"data": {
"totalNum":12,
"items":[
{
"gmtCreate":"xxx",
"gmtModified":"xxx",
"regIotId":"xxx",
"regProductKey":"xxx",
"regDeviceName":"xxx",
"enrolleeIotId":"xxx",
"enrolleeProductKey":"xxx",
"enrolleeDeviceName":"xxx",
"bssid":"xxx",
"ssid":"xxx",
"rssi":"xxx",
"type":0,
"status":1
}
]
},
"message": "success"
}
異常返回示例
JSON
格式
{
"code":460,
"message":"paramerror"
}