Files
AIGC/demo/SYSTEM_SETTINGS_CLEANUP_GUIDE.md

141 lines
3.3 KiB
Markdown
Raw Normal View History

# 系统设置页面任务清理功能使用说明
## 功能概述
系统设置页面新增了"任务清理管理"选项卡,提供了完整的任务清理功能,包括统计信息查看、清理操作执行和配置管理。
## 功能特性
### 1. 选项卡式界面
- **会员收费标准**: 原有的会员管理功能
- **任务清理管理**: 新增的任务清理功能
### 2. 清理统计信息
- 当前任务总数统计
- 已完成任务数量
- 失败任务数量
- 已归档任务数量
- 清理日志数量
- 保留天数配置
### 3. 清理操作
- **完整清理**: 将所有成功任务导出到归档表,删除失败任务
- **用户清理**: 清理指定用户的所有任务
### 4. 清理配置
- 任务保留天数设置
- 归档保留天数设置
- 配置保存功能
## 使用方法
### 1. 访问系统设置页面
1. 登录系统后,点击左侧导航栏的"系统设置"
2. 在页面顶部选择"任务清理管理"选项卡
### 2. 查看统计信息
1. 页面加载时自动获取统计信息
2. 点击"刷新"按钮手动更新统计信息
3. 统计信息包括:
- 当前任务总数
- 已完成任务数
- 失败任务数
- 已归档任务数
- 清理日志数
- 保留天数
### 3. 执行清理操作
#### 完整清理
1. 点击"执行完整清理"按钮
2. 系统将自动:
- 导出所有成功任务到归档表
- 记录失败任务到清理日志
- 删除原始任务记录
3. 清理完成后会显示结果统计
#### 用户清理
1. 点击"清理指定用户任务"按钮
2. 在弹出的对话框中输入用户名
3. 点击"确认清理"按钮
4. 系统将清理该用户的所有任务
### 4. 配置管理
1. 在"清理配置"区域设置参数:
- **任务保留天数**: 任务完成后保留的天数1-365天
- **归档保留天数**: 归档数据保留的天数30-3650天
2. 点击"保存配置"按钮保存设置
## 安全提示
### 1. 操作不可撤销
- 清理操作一旦执行,原始任务记录将被删除
- 请确保在清理前已备份重要数据
### 2. 用户清理警告
- 用户清理会删除该用户的所有任务记录
- 建议在清理前确认用户身份
### 3. 配置影响
- 修改保留天数会影响自动清理的行为
- 建议根据实际需求合理设置
## API接口
### 1. 获取统计信息
```
GET /api/cleanup/cleanup-stats
```
### 2. 执行完整清理
```
POST /api/cleanup/full-cleanup
```
### 3. 清理用户任务
```
POST /api/cleanup/user-tasks/{username}
```
## 测试功能
系统提供了测试页面来验证清理功能:
- 访问路径: `/cleanup-test`
- 提供所有API接口的测试功能
- 显示详细的请求和响应信息
## 故障排除
### 1. 统计信息获取失败
- 检查网络连接
- 确认API服务正常运行
- 查看浏览器控制台错误信息
### 2. 清理操作失败
- 检查数据库连接
- 确认有足够的权限
- 查看服务器日志
### 3. 配置保存失败
- 检查配置参数是否有效
- 确认有写入权限
- 重启应用使配置生效
## 最佳实践
### 1. 定期清理
- 建议每天执行一次完整清理
- 避免任务表数据过多影响性能
### 2. 监控统计
- 定期查看统计信息
- 关注失败任务数量变化
### 3. 合理配置
- 根据业务需求设置保留天数
- 平衡存储空间和数据保留需求
---
*文档更新时间: 2025-01-24*
*版本: 1.0*