Skip to content

Query Device Resources

API Address:/v2/deviceshadow/r2/openapi/device/resource

Request Method:GET

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

Response Data Type:*/*

API Description: Device resources

Request Parameters:

Parameter NameParameter DescriptionRequest TypeRequiredData TypeSchema
deviceKeyDevice keyquerytruestring
productKeyProduct keyquerytruestring
languageLanguage: CN/EN (default: CN)queryfalsestring

Response Status:

Status CodeDescriptionSchema
200OKActionResultOfQdDeviceStatus
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
dataObjectQdDeviceStatusQdDeviceStatus
  batteryBattery levelnumber(double)
  capabilitiesBitmaskDevice networking methodinteger(int32)
  cellIdBase station IDinteger(int64)
  comProtocolVerCommunication protocol versionstring
  createTimeCreation timestring(date-time)
  dataProtocolVerData protocol versionstring
  deviceIdDevice identifierstring
  deviceKeyDKstring
  iccIdICCID numberstring
  idIDinteger(int64)
  lacLocation Area Codeinteger(int64)
  locatorLocation function supportstring
  logEnableLog reporting duration switchinteger(int32)
  logLevelLog levelstring
  mccMobile Country Codeinteger(int64)
  mcuVersionMCU versionstring
  memoryFreeFree spaceinteger(int64)
  mncMobile Network Codeinteger(int64)
  phoneNumPhone numberstring
  productKeyPKstring
  rsrpReference Signal Received Powerinteger(int64)
  rsrqLTE Reference Signal Received Qualityinteger(int64)
  sdkVerSDK version numberstring
  signalStrengthSignal strengthinteger(int64)
  simNumSIM numberstring
  snDevice SNstring
  snrSignal to Noise plus Interference Ratiointeger(int64)
  typeModule modelstring
  updateTimeModification timestring(date-time)
  versionFirmware versionstring
  voltageVoltagenumber(double)
exp1string
msgPrompt messageobject
pageNumCurrent page numberobject
pageSizeItems per pageobject
pagesTotal pagesobject
totalTotal countobject

Response Example:

javascript
{
	"code": {},
	"data": {
		"battery": 0,
		"capabilitiesBitmask": 0,
		"cellId": 0,
		"comProtocolVer": "",
		"createTime": "",
		"dataProtocolVer": "",
		"deviceId": "",
		"deviceKey": "",
		"iccId": "",
		"id": 0,
		"lac": 0,
		"locator": "",
		"logEnable": 0,
		"logLevel": "",
		"mcc": 0,
		"mcuVersion": "",
		"memoryFree": 0,
		"mnc": 0,
		"phoneNum": "",
		"productKey": "",
		"rsrp": 0,
		"rsrq": 0,
		"sdkVer": "",
		"signalStrength": 0,
		"simNum": "",
		"sn": "",
		"snr": 0,
		"type": "",
		"updateTime": "",
		"version": "",
		"voltage": 0
	},
	"exp1": "",
	"msg": {},
	"pageNum": {},
	"pageSize": {},
	"pages": {},
	"total": {}
}