mirror of
https://github.com/EZ-Api/ez-api.git
synced 2026-01-13 17:47:51 +00:00
docs(admin): update dashboard and operations API references
- Add dashboard alerts, realtime, and apikey-stats endpoints - Document time range parameters for logs and apikey-stats - Update daily operations workflow with new monitoring endpoints - Clarify period parameter behavior (default returns all data)
This commit is contained in:
@@ -9,7 +9,9 @@
|
||||
|
||||
| 页面 | 接口 | 交互要点 |
|
||||
| --- | --- | --- |
|
||||
| Dashboard / 全局概览 | `GET /admin/stats` | 展示全局统计指标 |
|
||||
| Dashboard / 全局概览 | `GET /admin/dashboard/summary` `GET /admin/realtime` `GET /admin/stats` | 聚合指标、实时 QPS、传统统计 |
|
||||
| Dashboard / 告警 | `GET /admin/alerts` `GET /admin/alerts/stats` `POST /admin/alerts/:id/ack` `POST /admin/alerts/:id/resolve` | 告警列表、统计、确认、解决 |
|
||||
| Dashboard / 上游凭证统计 | `GET /admin/apikey-stats/summary` | 上游 API Key 成功率统计,支持时间范围 |
|
||||
| 操作日志 | `GET /admin/operation-logs` | 管理员操作审计 |
|
||||
| 租户(Masters)列表 | `GET /admin/masters` `POST /admin/masters` `POST /admin/masters/batch` | 列表 + 批量操作 |
|
||||
| 租户详情 | `GET /admin/masters/:id` `PUT /admin/masters/:id` `DELETE /admin/masters/:id` | 查看/编辑/删除 |
|
||||
@@ -47,7 +49,9 @@
|
||||
4. `PUT /admin/keys/:id/access` 细化 Key 的访问范围(可选)。
|
||||
|
||||
### 日常运维
|
||||
1. `GET /admin/logs` + `GET /admin/logs/stats` 查询异常与用量。
|
||||
1. `GET /admin/logs` + `GET /admin/logs/stats` 查询异常与用量(支持 `group_by=hour|minute`)。
|
||||
2. `PUT /admin/logs/webhook` 配告警;`DELETE /admin/logs` 清理。
|
||||
3. `GET /admin/stats`、`GET /admin/masters/:id/realtime` 查看实时指标。
|
||||
4. `PUT /admin/features` 调整 DP 开关;必要时 `POST /admin/sync/snapshot` 手动同步。
|
||||
3. `GET /admin/dashboard/summary`、`GET /admin/realtime`、`GET /admin/masters/:id/realtime` 查看实时指标。
|
||||
4. `GET /admin/alerts` + `GET /admin/alerts/stats` 查看系统告警;`POST /admin/alerts/:id/ack` 确认告警。
|
||||
5. `GET /admin/apikey-stats/summary` 查看上游凭证成功率(支持 `since/until` 时间范围)。
|
||||
6. `PUT /admin/features` 调整 DP 开关;必要时 `POST /admin/sync/snapshot` 手动同步。
|
||||
|
||||
@@ -298,10 +298,12 @@ graph TD
|
||||
**查询参数**:
|
||||
| 参数 | 类型 | 说明 | 默认值 |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| `period` | string | 预设周期:`today`, `week`, `month` | `today` |
|
||||
| `period` | string | 预设周期:`today`, `week`, `month`, `all` | 无(返回全量) |
|
||||
| `since` | int | 自定义起始时间 (Unix 秒) | - |
|
||||
| `until` | int | 自定义结束时间 (Unix 秒) | - |
|
||||
|
||||
> **注意**:若不传任何时间参数,返回全量数据(等同于 `period=all`)。
|
||||
|
||||
**响应示例**:
|
||||
```json
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user