ITOps Agent Platform

主题

附录B API接口速查表 ​

作者 ​

谭策 — 独立开发者 | AIOps 领域探索者

IT Online 微信公众号

许可证 ​

MPL-2.0 © 谭策

B.1 概述 ​

本速查表按功能分类列出 ITOps Agent Platform 后端的所有 RESTful API 接口。所有接口（除认证、Webhook 和健康检查外）均需要通过 Bearer Token 认证，即在请求头中添加 Authorization: Bearer <token>。

基础 URL: http://<host>:3001/api相关章节: 第6章 后端开发基础、第9章 API开发实战

B.2 认证相关接口 /api/auth ​

方法路径描述认证角色限制
POST/auth/login用户登录，返回 access token 和 refresh token否无
POST/auth/refresh刷新 access token否无
GET/auth/me获取当前登录用户信息是无
POST/auth/logout退出登录，将 token 加入黑名单是无
POST/auth/change-password修改密码是无

请求示例 登录:

bash
curl -X POST http://localhost:3001/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"admin"}'

响应示例:

json
{
  "success": true,
  "message": "登录成功",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIs...",
    "refreshToken": "eyJhbGciOiJIUzI1NiIs...",
    "user": {
      "id": "uuid",
      "username": "admin",
      "email": "admin@example.com",
      "role": "admin",
      "passwordMustChange": false
    }
  }
}

B.3 用户管理接口 /api/users ​

方法路径描述认证角色限制
GET/users获取用户列表是无
GET/users/:id获取单个用户详情是无
POST/users创建用户是admin
PUT/users/:id更新用户信息是admin
DELETE/users/:id删除用户是admin

B.4 服务器管理接口 /api/servers ​

方法路径描述认证角色限制
GET/servers获取服务器列表是无
GET/servers/:id获取单个服务器详情是无
POST/servers添加服务器是无
PUT/servers/:id更新服务器信息是无
DELETE/servers/:id删除服务器是admin, operator
GET/servers/:id/command-history获取服务器命令执行历史是无
GET/servers/:id/compliance-history获取合规检查历史是无
GET/servers/:id/command-history/export导出命令执行历史是无
GET/servers/:id/compliance-history/export导出合规检查历史是无

B.5 服务器分组接口 /api/server-groups ​

方法路径描述认证角色限制
GET/server-groups获取分组列表是无
GET/server-groups/tree获取分组树形结构是无
POST/server-groups创建分组是无
PUT/server-groups/:id更新分组是无
DELETE/server-groups/:id删除分组是无
POST/server-groups/:id/move移动服务器到分组是无
POST/server-groups/mapping创建服务器-分组映射是无
DELETE/server-groups/mapping删除服务器-分组映射是无
GET/server-groups/servers/:serverId获取服务器所属分组是无
GET/server-groups/groups/:groupId/servers获取分组下的服务器是无

B.6 服务器命令与合规接口 /api/server-commands ​

方法路径描述认证角色限制
POST/server-commands/:id/test测试服务器连接是admin, operator
POST/server-commands/:id/exec在远程服务器执行命令是admin, operator
GET/server-commands/compliance/checks获取合规检查项列表是无
POST/server-commands/:id/compliance执行合规检查是admin, operator

B.7 服务器运维管理接口 /api/server-management ​

方法路径描述认证角色限制
POST/server-management/:id/collect-info收集单台服务器信息是无
POST/server-management/collect-all收集所有服务器信息是无
POST/server-management/import批量导入服务器是无
GET/server-management/import-template获取服务器导入模板是无

B.8 Agent 管理接口 /api/agents ​

方法路径描述认证角色限制
GET/agents获取 Agent 列表是无
GET/agents/stats/summary获取 Agent 统计摘要是无
GET/agents/:id获取单个 Agent 详情是无
GET/agents/:id/executions获取 Agent 执行历史是无
POST/agents创建 Agent是admin, operator
POST/agents/:id/test测试 Agent是无
GET/agents/:id/test-input获取 Agent 测试输入模板是无
PUT/agents/:id更新 Agent是admin, operator
DELETE/agents/:id删除 Agent是admin, operator
POST/agents/import导入 Agent 配置是无
GET/agents/export/:id导出 Agent 配置是无

B.9 多 Agent 协作接口 /api/multi-agent ​

方法路径描述认证角色限制
POST/multi-agent/collaborate多 Agent 协作执行是无
GET/multi-agent/templates获取协作模板列表是无
POST/multi-agent/collaborate/from-template基于模板发起协作是无
GET/multi-agent/knowledge/search搜索知识库是无
POST/multi-agent/knowledge/inject注入知识到 Agent是无
POST/multi-agent/knowledge添加知识条目是无
POST/multi-agent/knowledge/batch批量添加知识是无
GET/multi-agent/knowledge/:id/similar查找相似知识是无
GET/multi-agent/knowledge/statistics获取知识统计是无
GET/multi-agent/history获取协作历史是无

B.10 工作流管理接口 /api/workflows ​

方法路径描述认证角色限制
GET/workflows获取工作流列表是无
GET/workflows/:id获取单个工作流详情是无
POST/workflows创建工作流是admin, operator
PUT/workflows/:id更新工作流是admin, operator
DELETE/workflows/:id删除工作流是admin, operator
POST/workflows/import导入工作流是admin, operator
GET/workflows/export/:id导出工作流是无

B.11 任务管理接口 /api/tasks ​

方法路径描述认证角色限制
GET/tasks获取任务列表是无
GET/tasks/:id获取单个任务详情是无
POST/tasks创建任务是无
PUT/tasks/:id/pause暂停任务是无
PUT/tasks/:id/resume恢复任务是无
PUT/tasks/:id/cancel取消任务是无
PUT/tasks/:id/intervene人工干预任务是无

B.12 定时任务接口 /api/scheduled-tasks ​

方法路径描述认证角色限制
GET/scheduled-tasks获取定时任务列表是无
GET/scheduled-tasks/:id获取单个定时任务详情是无
POST/scheduled-tasks创建定时任务是admin, operator
PUT/scheduled-tasks/:id更新定时任务是admin, operator
DELETE/scheduled-tasks/:id删除定时任务是admin, operator
POST/scheduled-tasks/:id/toggle启用/禁用定时任务是无
POST/scheduled-tasks/:id/run立即执行定时任务是无

B.13 告警管理接口 /api/alerts ​

方法路径描述认证角色限制
GET/alerts获取告警列表（支持分页、筛选）是无
GET/alerts/:id获取单个告警详情是无
POST/alerts创建告警是无
PUT/alerts/:id/acknowledge确认告警是无
PUT/alerts/:id/resolve解决告警是无
DELETE/alerts/:id删除告警是admin, operator
GET/alerts/stats/summary获取告警统计摘要是无

B.14 告警映射接口 /api/alert-mappings ​

方法路径描述认证角色限制
GET/alert-mappings获取告警-工作流映射列表是无
GET/alert-mappings/:id获取单个映射详情是无
POST/alert-mappings创建告警映射是无
PUT/alert-mappings/:id更新告警映射是无
DELETE/alert-mappings/:id删除告警映射是无

B.15 告警降噪接口 /api/alert-noise ​

方法路径描述认证角色限制
GET/alert-noise/stats获取降噪统计是无
GET/alert-noise/suppressed获取已抑制告警列表是无
POST/alert-noise/unsuppress取消抑制告警是无
POST/alert-noise/suppress抑制告警是无
POST/alert-noise/cleanup清理过期降噪数据是无

B.16 根因分析接口 /api/root-cause-analysis ​

方法路径描述认证角色限制
GET/root-cause-analysis获取根因分析列表是无
POST/root-cause-analysis创建根因分析是无
GET/root-cause-analysis/:id获取单个根因分析详情是无
PUT/root-cause-analysis/:id更新根因分析是无
POST/root-cause-analysis/:id/analyze执行根因分析是无
DELETE/root-cause-analysis/:id删除根因分析是无
GET/root-cause-analysis/alert/:alertId根据告警 ID 获取关联分析是无

B.17 自愈策略接口 /api/remediation-policies ​

方法路径描述认证角色限制
POST/remediation-policies创建自愈策略是admin, operator
GET/remediation-policies获取自愈策略列表是无
GET/remediation-policies/:id获取单个策略详情是无
PUT/remediation-policies/:id更新策略是admin, operator
DELETE/remediation-policies/:id删除策略是admin, operator
PATCH/remediation-policies/:id/toggle启用/禁用策略是无
GET/remediation-policies/:id/stats获取策略执行统计是无

B.18 自愈执行接口 /api/remediation-executions ​

方法路径描述认证角色限制
GET/remediation-executions获取执行记录列表是无
GET/remediation-executions/:id获取单个执行记录详情是无
POST/remediation-executions/:id/approve审批执行请求是无
POST/remediation-executions/:id/retry重试执行是无

B.19 知识库接口 /api/knowledge ​

方法路径描述认证角色限制
GET/knowledge获取知识条目列表是无
POST/knowledge创建知识条目是无
PUT/knowledge/:id更新知识条目是无
DELETE/knowledge/:id删除知识条目是无
GET/knowledge/search搜索知识条目是无

B.20 QAnything 知识库接口 /api/knowledge/qanything ​

方法路径描述认证角色限制
GET/knowledge/qanything/config获取 QAnything 配置是无
POST/knowledge/qanything/config更新 QAnything 配置是无
POST/knowledge/qanything/test测试 QAnything 连接是无
POST/knowledge/qanything/upload上传知识文档是无
POST/knowledge/qanything/upload-batch批量上传知识文档是无
GET/knowledge/qanything/document/:fileId获取文档状态是无
DELETE/knowledge/qanything/document/:fileId删除文档是无

B.21 脚本管理接口 /api/scripts ​

方法路径描述认证角色限制
GET/scripts获取脚本列表是无
GET/scripts/categories获取脚本分类是无
GET/scripts/:id获取单个脚本详情是无
POST/scripts创建脚本是admin, operator
PUT/scripts/:id更新脚本是admin, operator
DELETE/scripts/:id删除脚本是admin, operator

B.22 报告管理接口 /api/reports ​

方法路径描述认证角色限制
GET/reports/templates获取报告模板列表是无
GET/reports/templates/:id获取单个报告模板详情是无
POST/reports/templates创建报告模板是无
PUT/reports/templates/:id更新报告模板是无
DELETE/reports/templates/:id删除报告模板是无
GET/reports获取报告列表是无
GET/reports/:id获取单个报告详情是无
POST/reports/generate生成报告是无
GET/reports/:id/export导出报告是无
GET/reports/scheduled/all获取所有定时报告是无
GET/reports/scheduled/:id获取单个定时报告是无
POST/reports/scheduled创建定时报告是无
PUT/reports/scheduled/:id更新定时报告是无
DELETE/reports/scheduled/:id删除定时报告是无

B.23 通知管理接口 /api/notifications ​

方法路径描述认证角色限制
GET/notifications获取通知列表是无
PUT/notifications/:id/send发送通知是无
DELETE/notifications/:id删除通知是无
GET/notifications/stats/summary获取通知统计摘要是无

B.24 通知配置接口 /api/notification-config ​

方法路径描述认证角色限制
GET/notification-config获取通知配置是admin
PUT/notification-config更新通知配置是admin

B.25 系统设置接口 /api/settings ​

方法路径描述认证角色限制
GET/settings获取系统设置是无
PUT/settings更新系统设置是无
GET/settings/api-keys获取 API Key 配置是无
GET/settings/models获取可用模型列表是无
PUT/settings/api-keys更新 API Key 配置是无
DELETE/settings/api-keys/:provider删除 API Key 配置是无

B.26 审计日志接口 /api/audit ​

方法路径描述认证角色限制
GET/audit获取审计日志列表（支持分页、筛选）是无
GET/audit/:id获取单条审计日志详情是无
GET/audit/stats/summary获取审计统计摘要是无

B.27 Webhook 接收接口 /api/webhooks ​

方法路径描述认证角色限制
POST/webhooks/prometheus接收 Prometheus 告警否无
POST/webhooks/zabbix接收 Zabbix 告警否无
POST/webhooks/grafana接收 Grafana 告警否无
POST/webhooks/aliyun接收阿里云告警否无
POST/webhooks/tencent接收腾讯云告警否无
POST/webhooks/auto自动识别来源接收告警否无
POST/webhooks/generic接收通用格式告警否无

B.28 仪表盘接口 /api/dashboard ​

方法路径描述认证角色限制
GET/dashboard/stats获取仪表盘基础统计是无
GET/dashboard/alert-trends获取告警趋势数据是无
GET/dashboard/task-trends获取任务趋势数据是无
GET/dashboard/agent-stats获取 Agent 使用统计是无
GET/dashboard/task-distribution获取任务分布数据是无
GET/dashboard/remediation-stats获取自愈统计是无
GET/dashboard/sla-stats获取 SLA 统计是无
GET/dashboard/server-metrics获取服务器指标数据是无
GET/dashboard/full获取仪表盘完整数据是无
GET/dashboard/alert-source-stats获取告警来源统计是无

B.29 AI Copilot 接口 /api/copilot ​

方法路径描述认证角色限制
GET/copilot/suggestions获取智能建议是无
GET/copilot/conversations获取对话列表是无
POST/copilot/conversations创建新对话是无
GET/copilot/conversations/:id获取对话详情是无
DELETE/copilot/conversations/:id删除对话是无
POST/copilot/chat发送聊天消息是无

B.30 数据库管理接口 /api/database ​

方法路径描述认证角色限制
GET/database/stats获取数据库统计信息是admin
POST/database/maintenance执行数据库维护是admin
POST/database/maintenance/all执行全部维护操作是admin
GET/database/indexes获取索引信息是admin
GET/database/suggestions获取性能优化建议是admin

B.31 备份管理接口 /api/backups ​

方法路径描述认证角色限制
GET/backups/status获取备份状态是admin
GET/backups/config获取备份配置是admin
PUT/backups/config更新备份配置是admin
GET/backups/history获取备份历史是admin
POST/backups/create手动创建备份是admin
DELETE/backups/:id删除备份是admin
POST/backups/restore/:id从备份恢复是admin

B.32 导入导出接口 /api/import-export ​

方法路径描述认证角色限制
POST/import-export/servers/import导入服务器数据是admin
GET/import-export/servers/export导出服务器数据是admin
GET/import-export/alerts/export导出告警数据是admin
GET/import-export/audit-logs/export导出审计日志是admin
GET/import-export/reports/export导出报告数据是admin
GET/import-export/template/servers下载服务器导入模板否无

B.33 健康检查接口（公开） ​

方法路径描述认证角色限制
GET/health完整健康检查否无
GET/health/live存活探针（Liveness）否无
GET/health/ready就绪探针（Readiness）否无
GET/api/health/summary健康摘要是无
GET/api/health/history健康历史是无

B.34 WebSocket 实时通信 ​

除 RESTful API 外，平台还提供 WebSocket 接口用于实时通信：

事件方向描述
connection客户端→服务端建立 WebSocket 连接
command_output服务端→客户端推送远程命令执行输出
terminal_input客户端→服务端发送 SSH 终端输入
alert_new服务端→客户端推送新告警
task_status服务端→客户端推送任务状态变更
notification服务端→客户端推送系统通知
agent_progress服务端→客户端推送 Agent 执行进度

连接示例:

javascript
const socket = io('http://localhost:3001', {
  auth: { token: 'Bearer <your-jwt-token>' }
});

socket.on('command_output', (data) => {
  console.log(data.output);
});

socket.on('alert_new', (alert) => {
  console.log('新告警:', alert.title);
});

B.35 通用响应格式 ​

成功响应 ​

json
{
  "success": true,
  "message": "操作成功",
  "data": { ... }
}

错误响应 ​

json
{
  "success": false,
  "message": "错误描述",
  "error": "详细错误信息"
}

分页响应 ​

json
{
  "success": true,
  "data": { ... },
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "total": 100,
    "totalPages": 5
  }
}

B.36 通用查询参数 ​

大多数列表接口支持以下查询参数：

参数类型默认值说明
pagenumber1页码
pageSizenumber20每页数量
sortstringcreated_at排序字段
orderstringDESC排序方向：ASC/DESC
searchstring空全文搜索关键词
statusstring空按状态过滤
severitystring空按严重程度过滤

基于 MPL-2.0 许可证发布

Copyright © 2025-2026 谭策 | IT Online