Appearance
Query Gateway Device Child List
API Address:/v2/binding/enduserapi/getGatewayDeviceChildList
Request Method:GET
Request Data Type:application/x-www-form-urlencoded
Response Data Type:*/*
API Description:Query child device list under gateway device
Request Parameters:
| Parameter Name | Parameter Description | Request Type | Required | Data Type | Schema |
|---|---|---|---|---|---|
| dk | Gateway device dk | query | true | string | |
| pk | Gateway device pk | query | true | string | |
| gatewayType | Child device gateway type: 1-Network proxy only 2-Product integration (default) 3-Product integration + Network proxy | query | false | integer(int32) | |
| page | Current page, default is page 1 | query | false | integer(int32) | |
| pageSize | Page size, default is 10 items | query | false | integer(int32) |
Response Status:
| Status Code | Description | Schema |
|---|---|---|
| 200 | Successfully queried gateway device child list | Registration code response data«PageInfo«QbDevice»» |
| 5009 | Device verification failed | |
| 5032 | Token verification failed | |
| 5041 | No permission | |
| 5066 | Please enter Product Key | |
| 5067 | Please enter Device Key | |
| 5106 | Please enter token |
Response Parameters:
| Parameter Name | Parameter Description | Type | Schema |
|---|---|---|---|
| code | Response status code | integer(int32) | integer(int32) |
| data | Response data | PageInfo«QbDevice» | PageInfo«QbDevice» |
| endRow | integer(int64) | ||
| hasNextPage | boolean | ||
| hasPreviousPage | boolean | ||
| isFirstPage | boolean | ||
| isLastPage | boolean | ||
| list | array | QbDevice | |
| accessType | Access type: 0-Direct device 1-Gateway device 2-Gateway sub-device | string | |
| activedTime | Activation time | string | |
| activedTimeTs | integer | ||
| aiCapabilityStatus | AI capability switch status | boolean | |
| createTime | Creation time | string | |
| createTimeTs | integer | ||
| deviceKey | Device key | string | |
| deviceName | Device name | string | |
| deviceStatus | Device status 0-Offline 1-Online | integer | |
| deviceType | Device type: 1-Own device 2-Shared device | integer | |
| enabled | Whether enabled 0-Enabled, 1-Disabled, default is enabled | integer | |
| firstConnTime | First connection time | string | |
| firstConnTimeTs | integer | ||
| gatewayType | Child device access gateway type 1: Network proxy only 2: Product integration | integer | |
| id | Device id | integer | |
| isActived | Whether activated 0-Not activated 1-Activated | integer | |
| isCurrent | Whether it is the current connected gateway | integer | |
| isLiveness | Whether active 0-Not active 1-Active | integer | |
| isVerified | Whether secondary authentication is allowed 0-No 1-Yes | integer | |
| isVirtual | Whether it is a virtual device 0-Real 1-Virtual | integer | |
| lastConnTime | Most recent online time | string | |
| lastConnTimeTs | integer | ||
| lastOfflineTime | Last offline time | string | |
| lastOfflineTimeTs | integer | ||
| locateType | Device location type | string | |
| lowPowerAlive | Low power heartbeat period (minutes) | integer | |
| lowPowerCache | Low power cache duration, in seconds | integer | |
| lowPowerProduct | Whether it is a low power product. Yes: true, No: false | boolean | |
| lowPowerStatus | Low power status switch | boolean | |
| moduleType | Device model | string | |
| moduleVersion | Device version | string | |
| onlineStatus | Device online status: 0-Offline 1-Online | integer | |
| planId | Upgrade plan ID | integer | |
| productIcon | Product icon | string | |
| productId | Product id | integer | |
| productKey | Product key | string | |
| productName | Product name | string | |
| protocol | Default value 0, access protocol 1:mqtt, 2:lwm2m/coap, 3:http | integer | |
| status | Binding status: 1-Normal 2-Invalid | integer | |
| updateTime | Modification time | string | |
| updateTimeTs | integer | ||
| upgradeStatus | Device upgrade status | integer | |
| userConfirmStatus | User confirmation status | integer | |
| navigateFirstPage | integer(int32) | ||
| navigateLastPage | integer(int32) | ||
| navigatePages | integer(int32) | ||
| navigatepageNums | array | integer | |
| nextPage | integer(int32) | ||
| pageNum | integer(int32) | ||
| pageSize | integer(int32) | ||
| pages | integer(int32) | ||
| prePage | integer(int32) | ||
| size | integer(int32) | ||
| startRow | integer(int64) | ||
| total | integer(int64) | ||
| extMsg | Extended message | string | |
| msg | Response message | string |
Response Example:
javascript
{
"code": 0,
"data": {
"endRow": 0,
"hasNextPage": true,
"hasPreviousPage": true,
"isFirstPage": true,
"isLastPage": true,
"list": [
{
"accessType": "",
"activedTime": "",
"activedTimeTs": 0,
"aiCapabilityStatus": true,
"createTime": "",
"createTimeTs": 0,
"deviceKey": "",
"deviceName": "",
"deviceStatus": 0,
"deviceType": 0,
"enabled": 0,
"firstConnTime": "",
"firstConnTimeTs": 0,
"gatewayType": 0,
"id": 0,
"isActived": 0,
"isCurrent": 0,
"isLiveness": 0,
"isVerified": 0,
"isVirtual": 0,
"lastConnTime": "",
"lastConnTimeTs": 0,
"lastOfflineTime": "",
"lastOfflineTimeTs": 0,
"locateType": "",
"lowPowerAlive": 0,
"lowPowerCache": 0,
"lowPowerProduct": true,
"lowPowerStatus": true,
"moduleType": "",
"moduleVersion": "",
"onlineStatus": 0,
"planId": 0,
"productIcon": "",
"productId": 0,
"productKey": "",
"productName": "",
"protocol": 0,
"status": 0,
"updateTime": "",
"updateTimeTs": 0,
"upgradeStatus": 0,
"userConfirmStatus": 0
}
],
"navigateFirstPage": 0,
"navigateLastPage": 0,
"navigatePages": 0,
"navigatepageNums": [],
"nextPage": 0,
"pageNum": 0,
"pageSize": 0,
"pages": 0,
"prePage": 0,
"size": 0,
"startRow": 0,
"total": 0
},
"extMsg": "",
"msg": ""
}