Skip to content

Query Device Details

API Address:/v2/devicemgr/r3/openapi/device/detail

Request Method:GET

Request Data Type:application/x-www-form-urlencoded

Response Data Type:*/*

API Description: Device details query

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
deviceKeyDevice deviceKeyquerytruestring
productKeyProduct productKeyquerytruestring

Response Status:

Status CodeDescriptionSchema
200OKActionResultOfDeviceDetails
401Unauthorized
403Forbidden
404Not Found
50000Service exception
50005Parameter check error
70000Hub service unavailable
70089You have limited permission to operate this project or product or device
70130Non-existent device
91001Token does not exist
91004Token incorrect
91005Doesn't have permission
91006User not in IP white list
91007Please enable API permission

Response Parameters:

Parameter NameParameter DescriptionTypeSchema
codeReturn codeobject
dataObjectDevice detailsDevice details
  activedTimeDevice activation timeinteger(int64)
  authModeAuthentication method, 0-Dynamic authentication 1-Static authentication 2-X509, default 0integer(int32)
  createTimeCreation timeinteger(int64)
  dataFmtData format: 0-Transparent transmission, 3-Thing modelinteger(int32)
  deviceKeyDevice DKstring
  deviceNameDevice namestring
  deviceStatusDevice status: 1-Online, 0-Offlineinteger(int32)
  firstConnTimeFirst connection timeinteger(int64)
  isActivedWhether activated: 0-Not activated, 1-Activatedinteger(int32)
  isVerifiedSecondary authentication: 0-Not authenticated, 1-Authenticatedinteger(int32)
  isVirtualWhether virtual device: 0-Real, 1-Virtualinteger(int32)
  lastConnTimeLast online timeinteger(int64)
  lastOfflineTimeLast offline timeinteger(int64)
  productKeyProduct PKstring
  snDevice SNstring
  updateTimeUpdate timeinteger(int64)
exp1string
msgPrompt messageobject
pageNumCurrent page numberobject
pageSizeItems per pageobject
pagesTotal pagesobject
totalTotal countobject

Response Example:

javascript
{
	"code": {},
	"data": {
		"activedTime": 0,
		"authMode": 0,
		"createTime": 0,
		"dataFmt": 0,
		"deviceKey": "",
		"deviceName": "",
		"deviceStatus": 0,
		"firstConnTime": 0,
		"isActived": 0,
		"isVerified": 0,
		"isVirtual": 0,
		"lastConnTime": 0,
		"lastOfflineTime": 0,
		"productKey": "",
		"sn": "",
		"updateTime": 0
	},
	"exp1": "",
	"msg": {},
	"pageNum": {},
	"pageSize": {},
	"pages": {},
	"total": {}
}