4. 租户管理入门:创建租户、编辑租户信息、启用/禁用租户、删除租户
租户(Tenant)是 ThingsBoard 多租户架构中的核心隔离单元。每个租户拥有独立的设备、资产、仪表板、规则链和用户体系,租户之间默认不可见、不可访问。本章将演示租户生命周期的四个基本操作:创建、编辑、启用/禁用 和 删除。
前置条件: 你已使用 系统管理员(SysAdmin) 账户登录 ThingsBoard UI。系统管理员是唯一有权管理租户的角色。
4.1 租户生命周期概览
租户从创建到销毁的完整流程如下图所示。系统管理员通过 UI 或 REST API 控制每个阶段。
4.2 创建租户
创建租户是系统管理员在 ThingsBoard 中引入新业务实体(如新客户、新分公司)的第一步。
操作步骤
- 登录系统管理员账户,进入左侧菜单 “租户”(Tenants)页面。
- 点击右上角 “+” 按钮,选择 “添加租户”。
- 在弹出的对话框中填写租户信息。
- 点击 “添加” 完成创建。
关键字段说明
| 字段 | 是否必填 | 说明 |
|---|---|---|
| 标题(Title) | 是 | 租户的显示名称,如“智慧园区-A区”。 |
| 租户邮箱(Email) | 是 | 租户管理员的登录邮箱,系统会发送激活邮件。 |
| 国家/地区 | 否 | 用于地理标识,不影响功能。 |
| 地址/电话 | 否 | 附加联系信息,便于运营管理。 |
创建后自动生成: 每个新租户会获得一个唯一的 租户 ID(UUID),该 ID 将作为所有关联数据(设备、资产、仪表板)的隔离标识。
4.3 编辑租户信息
租户创建后,系统管理员可以随时修改其基本信息,无需重建租户。
操作步骤
- 在“租户”列表中找到目标租户。
- 点击该租户行右侧的 “编辑” 图标(铅笔形状)。
- 修改需要更新的字段(如标题、地址、联系电话等)。
- 点击 “保存” 生效。
注意: 租户邮箱(Email)在创建后 不可修改。如需更换邮箱,只能删除旧租户并重新创建。这是为了保持租户身份标识的稳定性。
4.4 启用与禁用租户
启用/禁用是 ThingsBoard 控制租户服务状态的核心开关。禁用租户不会删除数据,但会立即切断该租户的所有数据流和 API 访问。
状态对比
| 状态 | 设备数据上报 | 规则链执行 | 用户登录 | REST API 调用 |
|---|---|---|---|---|
| 活跃(启用) | 正常 | 正常 | 正常 | 正常 |
| 禁用 | 停止接收 | 暂停 | 禁止登录 | 返回 403 |
操作步骤
- 禁用租户: 在租户列表页,点击目标租户右侧的 “暂停” 图标(⏸️),确认后租户状态变为“禁用”。
- 启用租户: 在租户列表页,点击已禁用租户右侧的 “播放” 图标(▶️),确认后租户状态恢复为“活跃”。
使用场景: 当租户欠费、违规操作或需要临时维护时,系统管理员可快速禁用租户,避免数据丢失或安全风险。恢复启用后,所有配置和数据完整保留。
4.5 删除租户
删除租户是永久性操作,会移除该租户及其所有关联数据。执行前必须确认数据已备份或不再需要。
操作步骤
- 在“租户”列表中找到目标租户。
- 点击该租户行右侧的 “删除” 图标(垃圾桶形状)。
- 系统弹出确认对话框,提示“此操作将删除租户及其所有数据”。
- 输入 “yes” 确认,点击 “删除” 完成。
删除影响范围
| 数据类别 | 是否被删除 | 备注 |
|---|---|---|
| 设备、资产、实体视图 | 是 | 所有关联实体被级联删除 |
| 仪表板、规则链 | 是 | 自定义配置不可恢复 |
| 遥测数据、事件日志 | 是 | 历史数据永久丢失 |
| 租户管理员及子用户 | 是 | 所有账户被移除 |
不可逆操作: ThingsBoard 没有“回收站”机制。删除租户后,数据无法通过 UI 或 API 恢复。建议在删除前使用 备份导出 功能保存关键配置。
4.6 操作对比总结
下表汇总了四种租户管理操作的核心特征,便于快速查阅。
| 操作 | 是否影响数据 | 是否可逆 | 典型场景 |
|---|---|---|---|
| 创建 | 新增数据 | 可逆(可删除) | 引入新客户、新项目 |
| 编辑 | 修改元数据 | 可逆(可再次修改) | 更新联系方式、名称 |
| 启用/禁用 | 不删除数据 | 可逆(可切换) | 欠费暂停、维护窗口 |
| 删除 | 永久移除数据 | 不可逆 | 项目终止、数据迁移 |
最佳实践: 日常运维中优先使用 禁用 而非 删除 来处理不再活跃的租户。禁用操作保留了数据恢复的可能性,同时避免了误操作导致的数据丢失。