Skip to content

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 NameParameter DescriptionRequest TypeRequiredData TypeSchema
dkGateway device dkquerytruestring
pkGateway device pkquerytruestring
gatewayTypeChild device gateway type: 1-Network proxy only 2-Product integration (default) 3-Product integration + Network proxyqueryfalseinteger(int32)
pageCurrent page, default is page 1queryfalseinteger(int32)
pageSizePage size, default is 10 itemsqueryfalseinteger(int32)

Response Status:

Status CodeDescriptionSchema
200Successfully queried gateway device child listRegistration code response data«PageInfo«QbDevice»»
5009Device verification failed
5032Token verification failed
5041No permission
5066Please enter Product Key
5067Please enter Device Key
5106Please enter token

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeResponse status codeinteger(int32)integer(int32)
dataResponse dataPageInfo«QbDevice»PageInfo«QbDevice»
  endRowinteger(int64)
  hasNextPageboolean
  hasPreviousPageboolean
  isFirstPageboolean
  isLastPageboolean
  listarrayQbDevice
    accessTypeAccess type: 0-Direct device 1-Gateway device 2-Gateway sub-devicestring
    activedTimeActivation timestring
    activedTimeTsinteger
    aiCapabilityStatusAI capability switch statusboolean
    createTimeCreation timestring
    createTimeTsinteger
    deviceKeyDevice keystring
    deviceNameDevice namestring
    deviceStatusDevice status 0-Offline 1-Onlineinteger
    deviceTypeDevice type: 1-Own device 2-Shared deviceinteger
    enabledWhether enabled 0-Enabled, 1-Disabled, default is enabledinteger
    firstConnTimeFirst connection timestring
    firstConnTimeTsinteger
    gatewayTypeChild device access gateway type 1: Network proxy only 2: Product integrationinteger
    idDevice idinteger
    isActivedWhether activated 0-Not activated 1-Activatedinteger
    isCurrentWhether it is the current connected gatewayinteger
    isLivenessWhether active 0-Not active 1-Activeinteger
    isVerifiedWhether secondary authentication is allowed 0-No 1-Yesinteger
    isVirtualWhether it is a virtual device 0-Real 1-Virtualinteger
    lastConnTimeMost recent online timestring
    lastConnTimeTsinteger
    lastOfflineTimeLast offline timestring
    lastOfflineTimeTsinteger
    locateTypeDevice location typestring
    lowPowerAliveLow power heartbeat period (minutes)integer
    lowPowerCacheLow power cache duration, in secondsinteger
    lowPowerProductWhether it is a low power product. Yes: true, No: falseboolean
    lowPowerStatusLow power status switchboolean
    moduleTypeDevice modelstring
    moduleVersionDevice versionstring
    onlineStatusDevice online status: 0-Offline 1-Onlineinteger
    planIdUpgrade plan IDinteger
    productIconProduct iconstring
    productIdProduct idinteger
    productKeyProduct keystring
    productNameProduct namestring
    protocolDefault value 0, access protocol 1:mqtt, 2:lwm2m/coap, 3:httpinteger
    statusBinding status: 1-Normal 2-Invalidinteger
    updateTimeModification timestring
    updateTimeTsinteger
    upgradeStatusDevice upgrade statusinteger
    userConfirmStatusUser confirmation statusinteger
  navigateFirstPageinteger(int32)
  navigateLastPageinteger(int32)
  navigatePagesinteger(int32)
  navigatepageNumsarrayinteger
  nextPageinteger(int32)
  pageNuminteger(int32)
  pageSizeinteger(int32)
  pagesinteger(int32)
  prePageinteger(int32)
  sizeinteger(int32)
  startRowinteger(int64)
  totalinteger(int64)
extMsgExtended messagestring
msgResponse messagestring

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": ""
}