获取监控点值
(不建议使用接口获取实时数据!!!推荐使用MQTT协议推送)
功能说明
该接口可用于用户获取监控点值。(有频率限制,建议不要超过一秒一次,若超过一定频率,会屏蔽IP处理)
获取实时数据,建议使用MQTT协议推送
请求地址
旧版:(二选一)
URL1:
[apiBaseUrl]v2/box/{boxId}/dmon/value/get
URL2:
[apiBaseUrl]v2/dmon/value/get?boxNo={boxNo}
新版:(二选一)
URL1:
[Host Server]/api/v2/box/{boxId}/dmon/value/get
URL2:
[Host Server]/api/v2/dmon/value/get?boxNo={boxNo}
地址参数说明
字段名 类型 描述 apiBaseUrl string 详情见名词解释 boxId Long FBox列表获取接口中boxRegs下box下id boxNo string FBox的序列号 请求方式
POST
Headers
字段名 类型 描述 Authorization string Bearer+ 空格+登录接口中获得的access_token Body
JSON对象
字段名 类型 描述 ids jarray 监控点id集合,与names二选一,使用ids优先,少于100个元素。(优先使用ids参数传参) timeOut int 最大读取超时,null为取服务器默认值(6000ms) groupnames jarray 用于不同组下存在同名监控点的情况。与监控点名称集合联合使用,组名与监控点名称一 一对应 names jarray 监控点名称集合,与ids二选一,使用ids优先,少于100个元素。 响应成功
JSON数组字段名 类型 描述 id string 监控点Id timestamp datetime 时间戳,由于从缓存里拉的数据,所以需要时间戳来判断是否已经过期,UTC时间 dataType int 数据类型,见附录二 value string/int 值,根据数据类型返回值类型。 name string 监控点名称 boxId long 盒子Id status int 监控点状态,0:正常,1:无数据,2:超时,3:错误,4:Socket异常,5:FDS错误,16:未完成 connState int 盒子连接状态, 0:未知 , 1:已连接 ,2:超时, 3:断开 connStateTimestamp datatime 盒子的上线时间 返回码
字段名 描述 200 执行成功 401 accessToken过期 400 错误信息在HTTP Header里[X-FBox-Code],详细见附录三 404 接口不存在,请检查URL 429 访问接口频率过快,详情见429状态码 注意:
如果传的参数是使用 ids监控点id来传参,返回null 数据,请检查下传的参数是否是这个盒子下的监控点,监控点对应的是否是这个盒子号或者盒子boxid。
调用案例如下图