获取设备详情 - 联犀-things

请求参数

Header 参数

Ithings-Project-Id

string

可选

默认值:

Ithings-Token

string

可选

默认值:

app-code

string

可选

默认值:

device-id

string

可选

用户正在使用的设备ID(小程序,ios,安卓的设备ID)

Body 参数application/json

productID

string

可选

产品id 为空时获取所有产品

deviceName

string

设备名称读写

必需

withProperties

array[string]

可选

如果不为nil,如果为空,获取设备所有最新属性如果传了属性列表,则会返回属性列表

withProfiles

array[string]

可选

withOwner

boolean

可选

同时获取拥有人的信息

withGateway

boolean

可选

同时返回子设备绑定的网关信息

withArea

boolean

同时返回区域信息

可选

示例

{
  "productID": "string",
  "deviceName": "string",
  "withProperties": [
    "string"
  ],
  "withProfiles": [
    "string"
  ],
  "withOwner": true,
  "withGateway": true,
  "withArea": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

A successful response.

Body

code

integer

返回code

可选

默认值:

200

msg

string

返回的消息

可选

data

object (DeviceInfo)

可选

integer <int64>

可选

tenantCode

string

可选

productID

string

产品id 只读

必需

projectID

string

项目id 只读

可选

productName

string

可选

deviceType

integer <int64>

可选

设备类型:1:直连设备,2:网关,3:子设备,4:监控设备

productImg

string

产品图片

可选

areaID

string

项目区域id 只读

可选

deviceName

string

设备名称读写

必需

deviceAlias

string

设备别名读写

可选

secret

string

设备秘钥只读

可选

cert

string

设备证书只读

可选

imei

string

可选

IMEI号信息只读

mac

string

可选

MAC号信息只读

categoryID

integer <int64>

产品品类

可选

version

string

固件版本读写

可选

hardInfo

string

可选

模组硬件型号只读

softInfo

string

可选

模组软件版本只读

mobileOperator

integer <int64>

可选

移动运营商:1)移动 2)联通 3)电信 4)广电

<= 10

phone

string

手机号

可选

iccid

string

SIM卡卡号

可选

position

object (Point)

可选

address

string

所在地址

可选

adcode

string

地区编码

可选

tags

array[object (Tag) {2}]

设备tag

可选

schemaAlias

object

可选

设备物模型别名,如果是结构体类型则key为xxx.xxx

isOnline

integer <int64>

可选

在线状态 1离线 2在线只读

<= 2

firstLogin

string

激活时间只读

可选

firstBind

string

可选

lastBind

string

最后绑定时间只读

可选

lastLogin

string

最后上线时间只读

可选

expTime

string

到期时间

可选

logLevel

integer <int64>

可选

日志级别:1)关闭 2)错误 3)告警 4)信息 5)调试读写

<= 5

rssi

integer <int64>

信号强度

可选

createdTime

string

创建时间只读

可选

status

integer <int64>

可选

设备状态 1-未激活，2-在线，3-离线 4-异常(频繁上下线,告警中)

isEnable

integer <int64>

是否启用

可选

withProperties

object

可选

获取的属性列表,如果不传withProperty,则不会返回

protocolConf

array[object (Tag) {2}]

协议配置

可选

subProtocolConf

array[object (Tag) {2}]

子协议配置

可选

profiles

object

可选

owner

object (UserCore)

可选

ratedPower

integer <int64>

可选

netType

integer <int64>

可选

通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网,9:4G+BLE

<= 10

needConfirmVersion

string

待确认升级的版本

可选

userID

string

可选

lastIp

string

最后登录的ip地址

可选

sort

integer <int64>

排序

可选

desc

string

可选

distributor

object (IDPath)

可选

gateway

object (DeviceInfo)

可选

area

object (AreaInfo)

可选

groups

array[object (GroupCore) {4}]

所在分组信息

可选

示例

{
  "code": "200",
  "msg": "string",
  "data": {
    "id": 0,
    "tenantCode": "string",
    "productID": "string",
    "projectID": "string",
    "productName": "string",
    "deviceType": 0,
    "productImg": "string",
    "areaID": "string",
    "deviceName": "string",
    "deviceAlias": "string",
    "secret": "string",
    "cert": "string",
    "imei": "string",
    "mac": "string",
    "categoryID": 0,
    "version": "string",
    "hardInfo": "string",
    "softInfo": "string",
    "mobileOperator": 10,
    "phone": "string",
    "iccid": "string",
    "position": {
      "longitude": 180,
      "latitude": 90
    },
    "address": "string",
    "adcode": "string",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "schemaAlias": {},
    "isOnline": 2,
    "firstLogin": "string",
    "firstBind": "string",
    "lastBind": "string",
    "lastLogin": "string",
    "expTime": "string",
    "logLevel": 5,
    "rssi": 0,
    "createdTime": "string",
    "status": 0,
    "isEnable": 0,
    "withProperties": {},
    "protocolConf": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "subProtocolConf": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "profiles": {},
    "owner": {
      "userID": "string",
      "userName": "string",
      "email": "string",
      "phone": "string",
      "lastIP": "string",
      "regIP": "string",
      "nickName": "string",
      "headImg": "string",
      "createdTime": "string"
    },
    "ratedPower": 0,
    "netType": 10,
    "needConfirmVersion": "string",
    "userID": "string",
    "lastIp": "string",
    "sort": 0,
    "desc": "string",
    "distributor": {
      "id": 0,
      "idPath": "string"
    },
    "gateway": {},
    "area": {
      "projectID": "string",
      "areaID": "string",
      "areaName": "string"
    },
    "groups": [
      {
        "id": 0,
        "parentID": 0,
        "name": "string",
        "purpose": "string"
      }
    ]
  }
}