diff --git a/README.md b/README.md index 384b6dd..f556d81 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,46 @@ scrape_configs: - **Visualization**: ECharts / Canvas - **Frontend**: Vanilla JS / CSS3 +## API 接口文档 + +本项提供了完整的 RESTful API,用于数据采集、系统配置和状态监控。 + +### 1. 认证接口 (`/api/auth`) +- `POST /api/auth/login`: 用户登录 +- `POST /api/auth/logout`: 退出登录 +- `POST /api/auth/change-password`: 修改密码 (需登录) +- `GET /api/auth/status`: 获取当前登录状态 + +### 2. 数据源管理 (`/api/sources`) +- `GET /api/sources`: 获取所有 Prometheus 数据源及其状态 +- `POST /api/sources`: 添加新数据源 (需登录) +- `PUT /api/sources/:id`: 修改数据源信息 (需登录) +- `DELETE /api/sources/:id`: 删除数据源 (需登录) +- `POST /api/sources/test`: 测试数据源连接性 (需登录) + +### 3. 指标数据获取 (`/api/metrics`) +- `GET /api/metrics/overview`: 获取所有服务器的聚合实时指标 (CPU, 内存, 磁盘, 网络) +- `GET /api/metrics/network-history`: 获取全网 24 小时流量历史趋势 +- `GET /api/metrics/cpu-history`: 获取全网 CPU 使用率历史记录 +- `GET /api/metrics/server-details`: 获取特定服务器的详细实时指标 +- `GET /api/metrics/server-history`: 获取特定服务器的历史指标数据 +- `GET /api/metrics/latency`: 获取节点间的实时延迟数据 + +### 4. 系统配置与监控 +- `GET /api/settings`: 获取站点全局配置 +- `POST /api/settings`: 修改站点全局配置 (需登录) +- `GET /health`: 获取系统健康检查报告 (数据库、缓存、内存等状态) + +### 5. 延迟链路管理 (`/api/latency-routes`) +- `GET /api/latency-routes`: 获取配置的所有延迟检测链路 +- `POST /api/latency-routes`: 添加延迟检测链路 (需登录) +- `PUT /api/latency-routes/:id`: 修改延迟检测链路 (需登录) +- `DELETE /api/latency-routes/:id`: 删除延迟检测链路 (需登录) + +### 6. 实时通信 (WebSocket) +系统支持通过 WebSocket 接收实时推送,默认端口与 HTTP 服务一致: +- **消息类型 `overview`**: 包含聚合指标、服务器在线状态以及地理分布后的延迟链路数据。 + ## LICENSE MIT License