Appearance
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 Name | Parameter Description | Request Type | Required | Data Type | Schema |
---|---|---|---|---|---|
deviceKey | Device key | query | true | string | |
productKey | Product key | query | true | string | |
language | Language: CN/EN (default: CN) | query | false | string |
Response Status:
Status Code | Description | Schema |
---|---|---|
200 | OK | ActionResultOfQdDeviceStatus |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found | |
50000 | Service exception | |
50005 | Parameter check error | |
70000 | Hub service unavailable | |
70089 | You have limited permission to operate this project or product or device | |
70130 | Non-existent device | |
91001 | Token does not exist | |
91004 | Token incorrect | |
91005 | Doesn't have permission | |
91006 | User not in IP white list | |
91007 | Please enable API permission |
Response Parameters:
Parameter Name | Parameter Description | Type | Schema |
---|---|---|---|
code | Return code | object | |
data | Object | QdDeviceStatus | QdDeviceStatus |
battery | Battery level | number(double) | |
capabilitiesBitmask | Device networking method | integer(int32) | |
cellId | Base station ID | integer(int64) | |
comProtocolVer | Communication protocol version | string | |
createTime | Creation time | string(date-time) | |
dataProtocolVer | Data protocol version | string | |
deviceId | Device identifier | string | |
deviceKey | DK | string | |
iccId | ICCID number | string | |
id | ID | integer(int64) | |
lac | Location Area Code | integer(int64) | |
locator | Location function support | string | |
logEnable | Log reporting duration switch | integer(int32) | |
logLevel | Log level | string | |
mcc | Mobile Country Code | integer(int64) | |
mcuVersion | MCU version | string | |
memoryFree | Free space | integer(int64) | |
mnc | Mobile Network Code | integer(int64) | |
phoneNum | Phone number | string | |
productKey | PK | string | |
rsrp | Reference Signal Received Power | integer(int64) | |
rsrq | LTE Reference Signal Received Quality | integer(int64) | |
sdkVer | SDK version number | string | |
signalStrength | Signal strength | integer(int64) | |
simNum | SIM number | string | |
sn | Device SN | string | |
snr | Signal to Noise plus Interference Ratio | integer(int64) | |
type | Module model | string | |
updateTime | Modification time | string(date-time) | |
version | Firmware version | string | |
voltage | Voltage | number(double) | |
exp1 | string | ||
msg | Prompt message | object | |
pageNum | Current page number | object | |
pageSize | Items per page | object | |
pages | Total pages | object | |
total | Total count | object |
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": {}
}