查询网关的子设备列表
此接口用于获取查询指定网关下的子设备列表。
1 接口路径
GET /api/v1/topology
2 请求参数
query参数:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
gatewayId | BigInteger | 是 | 网关设备ID |
3 返回参数
统一返回参数说明参考:公共参数,以下是返回业务参数data
为列表,以下是列表元素描述:
名称 | 类型 | 描述 |
---|---|---|
id | BigInteger | 设备ID |
name | String | 设备名称 |
nodeType | String | 节点类型(设备 网关) |
productKey | String | 产品标识 |
productName | String | 产品名称 |
subNum | Integer | 子设备数量 |
status | String | 设备状态 (UN_ACTIVE、ONLINE、OFFLINE、FORBIDDEN、ENABLE) |
latelyOnlineTime | Long | 最近上线时间 |
4 返回状态码
公共状态码说明参考:公共参数,以下是业务关联的状态码说明:
code | 描述 |
---|---|
120106 | 网关设备不存在 |
5 示例
请求示例
/api/v1/topology/?gatewayId=301419944438996992
返回示例
{
"code": "000000",
"data": [
{
"id": "299967909357281280",
"name": "NO-2",
"nodeType": "DEVICE",
"productKey": "1_f15fa1e1c77",
"productName": "zunrong的子设备产品",
"status": "UN_ACTIVE",
"subNum": 0,
"latelyOnlineTime": 1562835034000
}
],
"message": "success"
}