Skip to content

基础

基础功能主要包括项目设置、访问控制、外部数据源、全局变量、API 密钥、操作日志等通用设置。

项目设置

在工作台导航菜单中选择【基础】【项目设置】进入项目设置界面,如下图所示。

image-20251208093136864

项目设置包括以下设置功能:

项目导入

用户可以在开发环境进行开发,开发完成后,可以导出项目资源包,然后再生产环境再进行项目导入。

项目导出

将当前项目配置的所有信息导出到项目资源包,导出内容不包括操作日志、告警日志、历史数据。

项目重置

项目重置用于清空当前项目内的全部设置和全部数据。

数据有效期

设备产生的时序数据会保存到时序数据库,默认保存 365 天,用户可以修改该保存时长。

访问控制

组织管理

按组织架构可以对用户进行分级管理;可以创建下级组织,指定的组织层级的用户,只允许访问该组织及以下级别的数据。

角色管理

创建角色,可以设置每个角色的操作权限,用户拥有其所属角色的所有权限。角色管理中分别可以从权限和角色两个视角去管理和授权权限,权限视角将列出所有的权限,从权限的角度去决定哪些角色拥有权限;而角色视角,可以根据角色去分配权限。

单击新建角色,开始添加一个角色:

用户管理

用于对登录平台的账号进行管理。多租户模式下,项目级用户只允许访问当前项目。

创建角色

新增账号可以设置用户、姓名、邮箱、手机号码以及该账号所属组织和角色,不同的角色决定了该用户可以使用的功能点。

编辑角色

打开角色编辑窗口,可以修改角色的名称和对这个角色权限进行重新分配,生效以后,角色下辖的账号会自动获得对应的权限。

删除角色

在角色列表中,可以单击角色的删除按钮清理不需要的角色。

操作日志

点击【基础】【操作日志】菜单,进入操作日志管理,可查看用户操作记录。支持以下检索条件:

  • 按操作日期进行检索;
  • 按操作对象进行检索;
  • 按操作类型类型进行检索;
  • 按操作人姓名进行检索;
  • 按操作人用户名进行检索;

image-20250603161354329

全局变量

全局变量是用户自定义的一种变量。可以用于在逻辑开发、告警规则、虚拟点计算、组态开发等各种场景中使用。

NOTE

全局变量功能需要 v5.6.0 及以上版本。

image-20250116113810142

命名空间

定义全局变量需要先定义命名空间,同一个命名空间下,变量名不可重复。

点击命名空间列表中的“+”按钮,弹出创建命名空间对话框,输入命名空间名称即可创建一个新的命名空间。

image-20250116113833794

变量管理

选中命名空间,可以在右侧的表格中查看该命名空间下的变量

点击“添加”按钮,可创建变量。

image-20250116114144669

image-20250116114331446

变量字段说明:

名称说明
名称变量名称,只能包含字母、数字和下划线,必须以字母开头,长度1-20个字符。
变量类型支持 4 种常用类型:字符串、布尔型、数值型、JSON
描述变量的描述信息

点击“查看值”按钮,可显示该变量的当前值,在输入框中输入新值,并点击“确定”按钮,可以对变量值进行修改。

image-20250116114821678

API 密钥

API 密钥是用于验证应用程序身份、控制 API 接口访问权限的安全凭证,主要功能包括:

  1. 身份验证:通过 “应用标识 + 应用密钥” 校验调用方合法性,防止非法请求。
  2. 流量管控:限制单位时间内的 API 访问次数,避免接口被恶意高频调用。
  3. 权限管理:可对不同应用的密钥配置不同权限范围,实现接口访问的精细化控制。
  4. 生命周期管理:支持密钥的创建、更新、启用 / 禁用、删除等操作,保障密钥安全性。

第三方应用访问平台的 API 接口需要使用 API 密钥进行安全验证。

image-20251127180648461

新建 API 密钥

  1. 操作入口:在 API 密钥管理页面,点击右上角「创建」按钮,弹出「新建应用密钥」窗口。
  2. 填写信息
    • 应用名称:输入不超过 20 个字符的名称(不可与已有名称重复)。
    • 流量控制:设置单位时间(默认 “分钟”)内的访问次数(当前默认 1 次 / 分钟,可按需调整)。
  3. 确认创建:填写完成后点击「确认」按钮,即可生成新的 API 密钥。

查看 API 密钥

在 API 密钥列表中,找到对应应用的「应用密钥」列,点击「显示」按钮,即可查看完整的 API 密钥(注意:密钥需妥善保管,避免泄露)。

更新 API 密钥

在 API 密钥列表的「应用密钥」列,点击「更新」按钮,系统会生成新的 API 密钥(旧密钥将失效,请及时同步至对应应用)。

编辑 API 信息

在 API 密钥列表的「操作」列,点击「编辑」按钮,可修改应用名称、流量控制等信息(修改后需点击保存生效)。

启用 / 禁用 API 密钥

在 API 密钥列表的「状态」列,点击「修改」按钮,可切换密钥的 “启用 / 禁用” 状态(禁用后该密钥无法调用 API)。

删除 API 密钥

  1. 单条删除:在 API 密钥列表的「操作」列,点击「删除」按钮,确认后即可删除该密钥。
  2. 批量删除:勾选列表中需删除的密钥,点击页面右上角「删除选中」按钮,批量删除选中的密钥。