Skip to content

queryDevice

调用该接口查询设备信息。

使用说明

暂无

接口地址

/gateway/openapi

请求方式

POST

请求参数

请求头

名称类型描述
tokenauthorizationString平台颁发的token
apiCodeString固定值:queryDevice

请求参数

QueryDeviceRequest

名称类型是否必选描述
deviceNameString设备名称
productKeyString产品Key

返回数据

QueryDeviceResponse

名称类型描述
codeString调用成功,返回0,调用失败,查看错误信息。
msgString调用成功,提示"操作成功",调用失败,查看错误信息。
dataObject返回结果。结果内容详情,查看下方示例。

result

名称类型描述
deviceIdString设备ID
productKeyString产品Key
deviceNameString设备名称
deviceSecretString设备密钥
deviceDescString备注
deviceUniqueNoString设备唯一信息编号
createTimeDate创建时间:格式为yyyy-MM-dd HH:mm:ss
activeTimeDate激活时间: 格式为yyyy-MM-dd HH:mm:ss
lastOnlineTimeDate最后上线时间:格式为yyyy-MM-dd HH:mm:ss
deviceStatusString设备状态:
  • offline-离线
  • not_active-未激活
  • online-在线
productNameString产品名称
productIdString产品ID
linkProtocolInteger协议类型:
  • MQTT
  • 其它
  • Modbus
  • OPC-UA
  • HTTP
topologyTypeInteger是否直连:
  • 1-直连
  • 2-非直连
parentDeviceNameString父设备名称
deviceModuleMapMap固件版本

示例

请求示例

json
{
  "deviceName": "O2Lr5urix",
  "productKey": "C2ae5peip"
}

返回示例

json
{
  "code": "0",
  "msg": "操作成功",
  "data": {
    "deviceId": "210bd76d37d743c19661dfa1dc34a919",
    "productKey": "C2ae5peip",
    "deviceName": "O2Lr5urix",
    "deviceSecret": "619765fc1e5257b1",
    "deviceDesc": "注册设备描述",
    "deviceUniqueNo": "O2Lr5urix",
    "createTime": "2023-10-25 10:53:14",
    "activeTime": null,
    "lastOnlineTime": null,
    "deviceStatus": "not_active",
    "productName": "飞鸿产品五",
    "productId": "f1ac33587fae4bc69785661634d378c8",
    "linkProtocol": "MQTT",
    "topologyType": 1,
    "parentDeviceName": null,
    "deviceModuleMap": {}
  }
}