Appearance
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 Name | Parameter Description | Request Type | Required | Data Type | Schema |
---|---|---|---|---|---|
deviceKey | Device deviceKey | query | true | string | |
productKey | Product productKey | query | true | string |
Response Status:
Status Code | Description | Schema |
---|---|---|
200 | OK | ActionResultOfDeviceDetails |
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 | Device details | Device details |
activedTime | Device activation time | integer(int64) | |
authMode | Authentication method, 0-Dynamic authentication 1-Static authentication 2-X509, default 0 | integer(int32) | |
createTime | Creation time | integer(int64) | |
dataFmt | Data format: 0-Transparent transmission, 3-Thing model | integer(int32) | |
deviceKey | Device DK | string | |
deviceName | Device name | string | |
deviceStatus | Device status: 1-Online, 0-Offline | integer(int32) | |
firstConnTime | First connection time | integer(int64) | |
isActived | Whether activated: 0-Not activated, 1-Activated | integer(int32) | |
isVerified | Secondary authentication: 0-Not authenticated, 1-Authenticated | integer(int32) | |
isVirtual | Whether virtual device: 0-Real, 1-Virtual | integer(int32) | |
lastConnTime | Last online time | integer(int64) | |
lastOfflineTime | Last offline time | integer(int64) | |
productKey | Product PK | string | |
sn | Device SN | string | |
updateTime | Update time | integer(int64) | |
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": {
"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": {}
}