Skip to content

仪表板数据 API ​

权限 ​

API密钥的权限会根据建立的用户而定

管理API密钥 ​

右上角账户设置页面可以管理你的API密钥,点击查看API密钥

alt text

alt text

点击新增来新增一把密钥

可以点击放大镜看到你的密钥

也可以直接做删除动作

alt text

API文档 ​

或者你可以点击API文档,可以去查阅有开放的API

alt text

这边会列出所有开放API,右上角的Authorize则是让你放置API密钥的地方

alt text

Value请填写您的API密钥

alt text

如果想要自行操作

只需要在HTTP Request Header带上

X-API-KEY: {你的API密钥}

就可以访问你的API

API简介 ​

目前提供下列几种API,来获取相关数据(详细的API使用方式可以参考API文档)

获取标签属性 ​

GET /dashboard/api/v2/open_api/hmi/{hw_key}/tags

获取指定HMI的所有标签信息,包含标签名称、数据类型、单位等属性。

获取标签历史数据 ​

POST /dashboard/api/v2/open_api/history

获取指定标签的历史数据,可以指定时间范围和采样方式,适合用于绘制趋势图或数据分析。

  • 可一次获取多个标签的历史数据,并且可以指定每个标签的采样方式(平均、总和、最大值、最小值等)
  • 有数据限制,详细限制可以参考数据限制章节

获取标签最新数据 ​

POST /dashboard/api/v2/open_api/latest

获取指定标签的最新数值,适合用于实时监控或仪表板显示。

  • 可一次获取多个标签的最新数据
  • 有数据限制,详细限制可以参考数据限制章节

获取警报分类 ​

GET /dashboard/api/v2/open_api/alarms/categories

获取系统中所有警报分类的列表,用于警报管理和分类查询。

获取警报规则 ​

POST /dashboard/api/v2/open_api/hmi/{hw_key}/alarms/rules

获取指定HMI的警报规则设定,包含触发条件、警报等级等信息。

获取警报历史记录 ​

POST /dashboard/api/v2/open_api/hmi/{hw_key}/alarms/history

获取指定HMI的警报历史记录,可以指定时间范围和筛选条件,用于警报追踪和分析。

数据限制 ​

为了确保系统稳定性,目前针对获取标签历史数据有做限制,限制条件如下

单次获取最多只能获取4320笔数据 ​

  • 在趋势图中的实时模式下,我们会以5秒当作单位来获取数据,这样最多只能获取到6小时内的数据

60(秒)*60(分钟)*6(小时)/5(秒) = 4320

  • 如果有开启合计模式,我们会以集合大小当作单位来获取数据 如果集合大小是1分钟,那么最多只能获取到3天内的数据

60(秒)*60(分钟)*24(小时)*3(天)/60(秒) = 4320

遇到单次获取限制时可以采取的手段 ​

  • 调整时间范围到限制内
  • 开启合计模式,并调整集合大小到更大的值,这样每次获取的数据量就会减少
  • 分段获取数据,将时间范围分成多个段落,每次获取一个段落的数据,最后将这些数据合并起来

流量限制 ​

目前单一HMI最多只允许15分钟内可以获取100MBytes左右的数据,超过这个限制会导致获取失败