配置管理
目录
一、功能概述
二、操作指南
一、功能概述
配置管理模块为系统提供全面的基本设置和环境配置能力，通过配置管理模块，管理员可集中控制系统各项设置，确保系统安全、高效运行。包含以下功能：
- 基本配置：系统的日志配置、服务发现配置和集成流配置。
- HTTPS证书：管理安全通信所需的数字证书，支持证书上传、更新和删除。
- 通知管理：配置系统告警日志的发布通道和发布通知。
- CDC服务器：配置CDC服务器。支持新增、更新和删除。
- 标签管理：创建和维护系统标签体系。
- 备份恢复：配置
- 系统备份策略，支持备份系统配置和系统还原功能。
- 密码强度：设置系统密码策略，包括复杂度要求、长度限制。
- 系统界面：自定义系统UI元素，包括名称、logo和默认显示设置等。
二、操作指南
（一）基本配置
基本配置提供了日志配置、服务发现配置、流程集成配置和队列配置等配置功能，管理员可以集中配置系统的基础运行环境，确保系统安全稳定运行。
1、日志配置
日志配置可以控制决定API网关运行时和ESB运行时是否默认记录请求和响应的完整报文内容（body部分），以及系统审计日志的开启和保留策略。
- 审计日志：默认为“是”：默认开启记录系统的审计日志。若选择“否”：关闭系统的审计日志记录。
- 日志迁移周期：默认为“30”，表示审计日志的默认迁移周期，如将30天之前的日志迁移到历史数据表当中。
2、服务发现配置
API网关支持将网关代理的dubbo服务重新注册到注册中心，给用户的客户端使用。
- 是否使用注册中心：是否将网关代理的dubbo服务重新注册到注册中心。
- Dubbo注册中心地址： 若使用Dubbo注册中心，请填写Dubbo注册中心的地址。
3、集成流配置
支持配置是否校验ESB流程的API请求路径，以及是否对集成流日志进行脱敏处理。
- 流程集成path校验： 验证TongESB的API请求路径的合法性和一致性。如选择“是”：系统将对ESB服务调用的路径进行严格检查。
- 逻辑组件脚本启用： 依据安全漏扫检测结果，自定义脚本存在代码执行漏洞，系统默认禁用该功能，如业务确需启用，需提前知晓风险。
- 流程集成日志脱敏： 是否对集成流日志中的加密信息脱敏处理。
- 脱敏位置： 脱敏日志的位置如请求头、请求体或响应头、响应体。
- 脱敏正则表达式： 待脱敏日志的正则表达式。
- 脱敏描述：此脱敏规则的功能描述。
4、队列配置
支持配置队列或主题。
- 新增队列： 新增一个主题或队列。
- 删除队列： 删除已有的主题或队列。
（二）HTTPS证书
HTTPS证书管理模块提供全面的HTTPS证书生命周期管理功能，用于建立API网关与后端服务之间的安全通信通道。通过强加密机制，确保API传输过程中的数据完整性和保密性。
- 导入证书：
通过HTTPS证书的导入，系统在API网关层实现TLS/SSL加密，构建端到端的安全通信链路，有效防御中间人攻击、数据窃听和身份伪造等安全威胁，为API的安全使用提供坚实的安全基础。
当前仅支持P12证书的导入。P12是一种安全容器格式，能在单个加密文件中同时包含SSL证书、中间证书和私钥。此格式具有较高安全性，通过密码保护机制防止未授权访问，特别适合证书完整传输与部署场景。常见的P12文件使用.p12或.pfx扩展名。
| 配置项 | 说明 |
|---|---|
| 名称 | 导入证书的名称，名称不得与已导入的证书重复。 |
| 描述 | 导入证书的描述。 |
| 选择证书 | 证书文件。（当前仅支持 P12 证书） |
| keystore密码 | 解密 P12 证书的密码，选填项。 |
| 证书别名 | 新建证书的别名。 |
- 下载：支持下载已上传证书。
- 删除：已导入的证书支持删除，删除后可重新导入同名证书。
- 查看证书：点击证书名称，用户可查看证书详情（包括keystore密码）。
（三）通知管理
支持配置系统告警日志的发布通道，集成电子邮件、微信公众号、短信、企业微信、钉钉等多种通知渠道，满足不同场景需求。支持
1、发布通道
支持配置消息发送的通道。发送通道支持“微信公众号”、“企业微信”、“邮箱”、“短信”以及“钉钉机器人”。
- 微信公众号：通过公众号模板消息将系统告警推送至用户微信，需指定AppID、AppSecret、消息模板ID。
| 配置项 | 说明 |
|---|---|
| AppID | 微信公众平台分配的应用唯一标识符，在微信公众平台获取，系统通过此ID建立与微信服务器的连接权限。 |
| AppSecret | 微信公众平台应用密钥，与AppID配对使用，用于获取接口调用凭证(access_token)。 |
| 模板ID | 预设的消息模板标识符，需在微信公众平台"模板消息"功能中添加并获取，告警信息将按此模板格式推送给已关注公众号的用户。 |
- 企业微信：需指定企业ID、应用ID、AppSecret，用于系统告警信息推送至企业微信。
| 配置项 | 说明 |
|---|---|
| 企业ID | 企业微信平台的企业唯一标识码(CorpID)，可在企业微信管理后台"我的企业"页面获取，用于识别消息发送方企业身份。 |
| 应用ID | 用于发送消息的企业微信应用标识(AgentID)，需在企业微信管理后台"应用管理"中创建自建应用并获取，系统通过此应用向员工发送告警通知。 |
| AppSecret | 企业微信的AppSecret。应用的访问密钥，在企业微信管理后台创建应用后生成，用于API调用身份验证。 |
- 邮箱：需指定协议、邮箱服务器、邮箱服务器端口、发件人、用户名、密码。
| 配置项 | 说明 |
|---|---|
| 协议 | 邮件传输协议类型，通常为SMTP(简单邮件传输协议)或SMTPS(安全版SMTP) |
| 邮件服务器 | 发送邮件的SMTP服务器地址，如"smtp.gmail.com"等，请根据邮箱服务提供商填写正确的服务器域名。 |
| 邮件服务器端口 | SMTP服务器的通信端口，标准端口通常为25(非加密)、465(SSL加密)或587(TLS加密)，须与服务器设置和协议类型匹配。 |
| 是否启用SSL/TLS | 控制邮件传输是否使用加密连接，启用加密可防止邮件内容在传输过程中被窃取，生产环境建议开启。 |
| 发件人 | 显示在收件人邮箱中的发件人名称。 |
| 用户名 | SMTP服务器的认证用户名，通常为完整的邮箱地址，用于邮件服务器登录验证。 |
| 密码 | 邮箱账户密码。 |
- 短信：腾讯云、阿里云短信消息通道，需指定SDK AppID、AppKey、短信签名、模板ID。
| 配置项 | 说明 |
|---|---|
| 短信平台 | 短信平台可选: 阿里云、腾讯云。 |
| AccessKey ID | 云平台提供的访问身份识别ID，用于API身份认证，可从对应云服务商控制台获取。 |
| AccessKey Secret | 与AccessKey ID配对的访问密钥。 |
| 短信签名 | 短信内容前显示的企业或品牌标识，必须是已在短信服务商平台审核通过的签名。 |
| 模板ID | 短信内容模板的唯一标识码，必须使用已在短信服务商平台预先审核通过的模板ID。 |
- 钉钉机器人：需指定webhook地址、自定义关键字、签名。
| 配置项 | 说明 |
|---|---|
| Webhook地址 | 钉钉发布通知的钉钉群机器人的唯一接口地址。在钉钉群设置中创建自定义机器人后获取，所有通知将通过此地址推送至指定钉钉群。 |
| 自定义关键字 | 自定义关键字，可以设置多个用逗号“,”隔开。钉钉安全设置要求的消息过滤关键词，消息中必须包含至少一个关键词才能发送成功。多个关键词用逗号分隔，系统将自动在告警消息中添加这些关键词以确保消息能正常送达。 |
| 签名 | 钉钉机器人的安全验证密钥(secret)。 |
2、发布通知
支持配置告警通知的事件类型、通知人和通知方式等。
- 新建通知：支持新建告警通知。
| 配置项 | 说明 |
|---|---|
| 事件类型 | 分为“集成流监控”和“运行时监控”。告警通知的类型。 |
| API分类 | 需要监控并发送告警的API分类。 |
| 名称 | 告警规则名称。 |
| 通知对象 | 可选接收人或接收组。接收人可选系统内用户，会给指定人发送告警通知。接收组可选系统内的机构，若选择接收组，会给该机构下的所有人发送告警通知。 |
| 通知方式 | 告警规则触发后可通过“微信”、“企业微信”、“邮件”、“短信”、“钉钉机器人”向特定“通知对象”进行消息通知。 |
| 接口回调 | 告警规则触发之后可以调用用户预先配置的接口，单击下方的蓝色“添加”文字，可添加多个。 |
- 删除通知：支持批量删除告警通知。
（四）CDC服务器
CDC 是一种通过解析数据库事务日志实现增量数据同步的技术，支持全量或增量方式捕获源库的插入、更新及删除操作。本系统通过集成已部署的CDC服务配置，将捕获管道接入数据处理链路，为下游模块（如CDC触发器等场景）提供低延迟、低侵入的变更数据流
- 新建CDC服务器：
| 配置项 | 说明 |
|---|---|
| 服务器名 | CDC服务器在本系统的名称。 |
| 服务器IP | CDC服务器安装部署服务器的IP。 |
| 数据同步端口 | 数据同步端口。 |
| 用户名 | CDC的用户名。 |
| 密码 | CDC的密码。 |
- 编辑CDC：支持更新CDC服务器信息。
- 删除CDC：支持删除。
（五）标签管理
标签管理系统提供全面的标签创建与维护功能。支持标签数据的导出和导入，便于批量维护和跨系统迁移。可设置标签启用/停用状态，灵活控制标签在系统中的可见性。
- 新建标签：支持新建标签，配置标签的所属分类、名称、所属分类中的顺序和状态。
| 配置项 | 说明 |
|---|---|
| 上级分类 | 此标签的所属分类名称。 |
| 标签名称 | 新建标签的名称，标签的唯一标识符，系统内不可重复。 |
| 顺序 | 新建标签在同级分类中的展示位置。 |
| 标签描述 | 新建标签的描述，补充说明标签用途和适用范围。 |
| 标签状态 | 标签的状态，默认是启用状态，可以停用此标签。 |
| 创建人 | 新建标签的创建人。 |
- 删除标签：支持删除标签。
- 导出标签：表格中显示的标签列表，支持批量导出为文件，方便线下修改。
- 导入标签： 导出的标签列表文件，支持重新导入。
（六）备份恢复
备份恢复支持系统配置数据的全局备份和恢复。
- 数据备份
数据备份工具提供系统关键数据的安全保存机制，确保在系统故障或数据丢失情况下能够快速恢复。支持备份TUS配置数据，自动生成带时间戳的压缩文件，并实时显示备份进度与状态。
执行步骤: 进入数据备份页面； ——> 勾选需要备份的数据类型（如"TongTUS管理数据"）； ——> 点击"备份"按钮启动备份流程； ——> 系统自动执行备份任务，界面实时显示进度条； ——>备份完成后，系统显示备份状态并提供备份文件信息。
特别提醒： 备份完成的文件目录为：管理中心安装目录/backup_recovery，可通过文件名（包含日期时间戳）区分不同备份版本。
- 数据恢复
数据恢复工具允许用户从之前创建的备份文件中还原系统数据，确保在数据丢失或系统迁移情况下能够快速恢复业务连续性。系统支持选择特定备份文件进行精确恢复，并提供实时进度反馈。
执行步骤: 进入数据恢复页面； ——> 将旧系统的 管理中心安装目录/backup_recovery/目录下的备份文件，保存到新系统的 管理中心安装目录/backup_recovery目录下。（新安装的管理中心没有backup_recovery目录的话需要手动新建一个） ——> 从下拉菜单中选择需要恢复的备份文件； ——> 点击"恢复"按钮启动恢复流程； ——> 系统自动执行数据恢复过程，界面实时显示进度情况； ——> 待系统完成数据恢复后，请重启系统。
特别提醒： 数据恢复期间，请不要操作系统，数据恢复完成后请重启系统。
（七）密码强度
设置用户密码的长度和密码强度。
- 密码强度设置
| 参数 | 参数说明 |
|---|---|
| 密码长度 | 设置用户密码的最小长度和最大长度。长度为8到16位的区间。 |
| 密码强度 | 指定用户密码的强度校验规则，可选值为大写字母、小写字母、数字、特殊字符。 |
（八）系统界面
系统界面模块提供全面的平台品牌定制能力，支持管理员自定义系统的视觉标识和描述信息，确保企业形象的一致性展示。通过简单配置，即可完成系统前端界面的个性化定制，提升企业应用平台的专业形象。
- 系统界面配置
| 参数 | 参数说明 |
|---|---|
| 版权信息 | 设置系统底部显示的版权声明文本。 |
| 平台Logo | 上传企业或平台的标志图片，强化品牌视觉识别。 |
| 登录页背景图 | 上传登录平台的登录页面的背景图。 |
| 登录框背景Logo | 上传登录页面登录框的背景Logo。 |