在鸿云文档Appearance
listDeviceByProductKey
调用该接口根据产品ProductKey查询设备列表。
使用说明
暂无
接口地址
/gateway/openapi
请求方式
POST
请求参数
请求头
| 名称 | 类型 | 描述 |
|---|---|---|
| tokenauthorization | String | 平台颁发的token |
| apiCode | String | 固定值：listDeviceByProductKey |
请求参数
ListDeviceRequest
| 名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| productKey | String | 是 | 产品Key |
返回数据
QueryDeviceResponse
| 名称 | 类型 | 描述 |
|---|---|---|
| code | String | 调用成功，返回0，调用失败，查看错误信息。 |
| msg | String | 调用成功，提示"操作成功"，调用失败，查看错误信息。 |
| data | Object | 返回结果。结果内容详情，查看下方示例。 |
deviceList
| 名称 | 类型 | 描述 |
|---|---|---|
| deviceId | String | 设备ID |
| productKey | String | 产品Key |
| deviceName | String | 设备名称 |
| deviceSecret | String | 设备密钥 |
| deviceDesc | String | 备注 |
| deviceUniqueNo | String | 设备唯一信息编号 |
| createTime | Date | 创建时间：格式为yyyy-MM-dd HH:mm:ss |
| activeTime | Date | 激活时间： 格式为yyyy-MM-dd HH:mm:ss |
| lastOnlineTime | Date | 最后上线时间：格式为yyyy-MM-dd HH:mm:ss |
| deviceStatus | String | 设备状态：
|
| productName | String | 产品名称 |
| productId | String | 产品ID |
| linkProtocol | Integer | 协议类型：
|
| topologyType | Integer | 是否直连：
|
| parentDeviceName | String | 父设备名称 |
| deviceModuleMap | Map | 固件版本 |
示例
请求示例
json
{
"productKey": "F4wg3MgrM"
}返回示例
json
{
"code": "0",
"msg": "操作成功",
"data": [
{
"deviceId": "34242",
"productKey": "F4wg3MgrM",
"deviceName": "1233243",
"deviceSecret": "034e84fe65f4f11d",
"deviceDesc": "1",
"deviceUniqueNo": "123",
"createTime": "2025-06-05 10:19:16",
"activeTime": "2025-07-16 16:28:19",
"lastOnlineTime": "2025-07-28 15:50:03",
"deviceStatus": "offline",
"productName": "浸水器",
"productId": null,
"linkProtocol": null,
"topologyType": null,
"parentDeviceName": null,
"deviceModuleMap": null
},
{
"deviceId": "342424324",
"productKey": "F4wg3MgrM",
"deviceName": "1233243e3542",
"deviceSecret": "bdb60360808c693c",
"deviceDesc": "1",
"deviceUniqueNo": "123er3",
"createTime": "2025-06-05 10:36:07",
"activeTime": "2025-06-19 17:27:15",
"lastOnlineTime": "2025-06-19 17:27:15",
"deviceStatus": "offline",
"productName": "浸水器",
"productId": null,
"linkProtocol": null,
"topologyType": null,
"parentDeviceName": null,
"deviceModuleMap": null
}
]
}