所有接口 URL 均以
https://api.flashcat.cloud 为 base,通过 query string 中的 APP Key 认证。On-call(202 个接口)
On-call(202 个接口)
故障管理
协作空间
告警管理
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /alert/list | 查询告警列表 |
| POST | /alert/info | 查看告警详情 |
| POST | /alert/list-by-ids | 批量查询告警 |
| POST | /alert/event/list | 查询告警事件列表 |
| POST | /alert/feed | 查询告警动态 |
| POST | /alert/merge | 将告警合并到故障 |
| POST | /alert/pipeline/info | 查看告警处理规则 |
| POST | /alert/pipeline/list | 批量查询告警处理规则 |
| POST | /alert/pipeline/upsert | 创建或更新告警处理规则 |
| POST | /alert-event/list | 查询原始告警事件列表 |
集成中心
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /webhook/history/list | 查询 Webhook 推送历史 |
| POST | /webhook/history/detail | 获取 Webhook 推送详情 |
| POST | /datasource/im/person/try-link | 尝试关联 IM 人员 |
| POST | /integration/type/list | 查询集成类型列表 |
| POST | /integration/list | 查询集成列表 |
| POST | /integration/info | 查询集成详情 |
| POST | /integration/create | 创建集成 |
| POST | /integration/update | 更新集成 |
| POST | /integration/delete | 删除集成 |
| POST | /integration/enable | 启用集成 |
| POST | /integration/disable | 禁用集成 |
| POST | /integration/key/rotate | 轮换集成 Key |
值班排班
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /schedule/create | 创建值班表 |
| POST | /schedule/update | 更新值班表 |
| POST | /schedule/preview | 预览值班表 |
| POST | /schedule/delete | 删除值班表 |
| POST | /schedule/info | 获取值班表详情 |
| POST | /schedule/list | 查询值班表列表 |
| POST | /schedule/self | 查询我的值班表 |
| POST | /schedule/by-person | 查看成员值班状态 |
| POST | /schedule/infos | 批量获取值班表 |
许可管理
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /oncall/license/list | 查询 On-call 许可列表 |
日历管理
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /calendar/create | 创建服务日历 |
| POST | /calendar/update | 更新服务日历 |
| POST | /calendar/delete | 删除服务日历 |
| POST | /calendar/info | 获取服务日历详情 |
| POST | /calendar/list | 查询服务日历列表 |
| POST | /calendar/event/upsert | 创建或更新日历事件 |
| POST | /calendar/event/delete | 删除日历事件 |
| POST | /calendar/event/list | 查询日历事件列表 |
通知模板
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /template/info | 查看模板详情 |
| POST | /template/list | 查询模板列表 |
| POST | /template/create | 创建模板 |
| POST | /template/update | 更新模板 |
| POST | /template/delete | 删除模板 |
| POST | /template/preview | 预览模板 |
标签增强
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /enrichment/info | 查看富化规则 |
| POST | /enrichment/list | 批量查询富化规则 |
| POST | /enrichment/upsert | 创建或替换富化规则 |
| POST | /enrichment/mapping/schema/list | 查询映射规则列表 |
| POST | /enrichment/mapping/schema/info | 查看映射规则详情 |
| POST | /enrichment/mapping/schema/create | 创建映射规则 |
| POST | /enrichment/mapping/schema/update | 更新映射规则 |
| POST | /enrichment/mapping/schema/delete | 删除映射规则 |
| POST | /enrichment/mapping/data/list | 查询映射数据列表 |
| POST | /enrichment/mapping/data/upsert | 写入映射数据 |
| POST | /enrichment/mapping/data/delete | 删除映射数据 |
| POST | /enrichment/mapping/data/truncate | 清空映射数据 |
| POST | /enrichment/mapping/data/upload | 通过 CSV 上传映射数据 |
| POST | /enrichment/mapping/data/download | 下载映射数据 CSV |
| POST | /enrichment/mapping/api/list | 查询映射 API 列表 |
| POST | /enrichment/mapping/api/info | 查看映射 API 详情 |
| POST | /enrichment/mapping/api/create | 创建映射 API |
| POST | /enrichment/mapping/api/update | 更新映射 API |
| POST | /enrichment/mapping/api/delete | 删除映射 API |
| POST | /field/info | 查看自定义字段 |
| POST | /field/list | 查看自定义字段列表 |
| POST | /field/create | 创建自定义字段 |
| POST | /field/update | 变更自定义字段 |
| POST | /field/delete | 删除自定义字段 |
分析看板
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /insight/alert/topk-by-label | 查看按 check/resource 聚合的 Top-K 告警 |
| POST | /insight/account | 查看账户级别洞察 |
| POST | /insight/incident/list | 查询洞察故障列表 |
| POST | /insight/incident/export | 导出洞察故障 |
| POST | /insight/channel | 查看协作空间洞察 |
| POST | /insight/channel/export | 导出协作空间洞察 |
| POST | /insight/team | 查看团队洞察 |
| POST | /insight/team/export | 导出团队洞察 |
| POST | /insight/responder | 查看处理人员洞察 |
| POST | /insight/responder/export | 导出处理人员洞察 |
状态页
变更管理
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /change/list | 查询变更列表 |
IM 集成
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /datasource/im/war-room-enabled/list | 查看开启作战室功能的集成 |
Monitors(41 个接口)
Monitors(41 个接口)
告警规则
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /monit/rule/list/basic | 查询告警规则列表 |
| POST | /monit/rule/v2/info | 获取告警规则详情 V2 |
| POST | /monit/rule/v2/create | 创建告警规则 V2 |
| POST | /monit/rule/v2/update | 更新告警规则 V2 |
| POST | /monit/rule/delete | 删除告警规则 |
| POST | /monit/rule/delete/batch | 批量删除告警规则 |
| POST | /monit/rule/update/fields | 批量更新规则字段 |
| POST | /monit/rule/move | 移动告警规则到文件夹 |
| POST | /monit/rule/audits | 查询规则变更历史 |
| POST | /monit/rule/audit/detail | 查看规则审计快照 |
| POST | /monit/rule/counter/total | 查看规则数量时序 |
| POST | /monit/rule/counter/channel | 按协作空间查询规则统计 |
告警规则的导入与导出仅在控制台提供(YAML 规则包流程,见告警规则入门指南):Monitors 服务端已下线
POST /monit/rule/export 与 POST /monit/rule/import,API 参考中也已不再收录这两个接口。告警数据源
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /monit/datasource/list | 查询数据源列表 |
| POST | /monit/datasource/info | 查看数据源详情 |
| POST | /monit/datasource/create | 创建数据源 |
| POST | /monit/datasource/update | 更新数据源 |
| POST | /monit/datasource/delete | 删除数据源 |
| POST | /monit/datasource/tools/invoke | 调用数据源工具 |
| POST | /monit/datasource/sls/projects | 查询 SLS 项目列表 |
| POST | /monit/datasource/sls/logstores | 查询 SLS 日志库列表 |
| GET | /monit/prometheus/api/v1/label/{label_name}/values | 查询 Prometheus 标签值列表 |
诊断分析
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /monit/query/data | 查询结构化数据 |
| POST | /monit/query/explore | 执行探索查询 |
通用工具
| 方法 | 接口 | 描述 |
|---|
仪表盘
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /monit/dashboard/list | 查询仪表盘列表 |
| POST | /monit/dashboard/search | 搜索仪表盘 |
| POST | /monit/dashboard/get | 查看仪表盘详情 |
| POST | /monit/dashboard/outline | 获取仪表盘大纲 |
| POST | /monit/dashboard/create | 创建仪表盘 |
| POST | /monit/dashboard/update | 更新仪表盘 |
| POST | /monit/dashboard/move | 移动仪表盘 |
| POST | /monit/dashboard/delete | 删除仪表盘 |
| POST | /monit/dashboard/restore | 恢复仪表盘 |
| POST | /monit/dashboard/trash/list | 查询回收站仪表盘 |
| POST | /monit/dashboard/revisions/list | 查询仪表盘版本列表 |
| POST | /monit/dashboard/revisions/get | 查看仪表盘版本详情 |
| POST | /monit/dashboard/runtime/variables/resolve | 解析仪表盘变量 |
| POST | /monit/dashboard/runtime/variables/preview | 预览草稿变量 |
| POST | /monit/dashboard/runtime/queries/resolve | 解析面板查询 |
| POST | /monit/dashboard/panel/run | 运行仪表盘面板 |
| POST | /monit/dashboard/panel/preview | 预览草稿面板 |
规则分组
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /monit/folder/list | 查询监控节点列表 |
RUM(41 个接口)
RUM(41 个接口)
RUM 自定义字段
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /rum/facet/count | 查询分值分布 |
| POST | /rum/field/list | 查询字段列表 |
应用管理
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /rum/application/webhook/test | 测试应用 Webhook |
| POST | /rum/application/remote-config/history/revert | 回滚远程配置版本 |
| POST | /rum/application/remote-config/history/list | 查询远程配置历史列表 |
| POST | /rum/application/remote-config/preview | 预览远程配置 |
| POST | /rum/application/remote-config/update | 更新远程配置 |
| POST | /rum/application/remote-config/get | 查看远程配置详情 |
| POST | /rum/application/list | 查询应用列表 |
| POST | /rum/application/infos | 批量查询应用详情 |
| POST | /rum/application/info | 查看应用详情 |
| POST | /rum/application/delete | 删除应用 |
| POST | /rum/application/create | 创建应用 |
| POST | /rum/application/update | 更新应用 |
RUM 问题跟踪
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /rum/issue/export | 导出 Issue 列表 |
| POST | /rum/issue/info | 查看 Issue 详情 |
| POST | /rum/issue/list | 查询 Issue 列表 |
| POST | /rum/issue/update | 更新 Issue |
RUM 会话回放
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /rum/session-replay/metadata | 查看会话回放元数据 |
| POST | /rum/session-replay/segments | 查询会话回放分段 |
RUM Sourcemap
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /sourcemap/stack/enrich | 丰富错误栈信息 |
| POST | /sourcemap/list | 查询 Sourcemap 列表 |
RUM 数据查询
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /rum/data/query | 查询 RUM 数据 |
错误采集规则
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /rum/error-ingestion/rules/list | 查询错误采集规则列表 |
| POST | /rum/error-ingestion/rules/create | 创建错误采集规则 |
| POST | /rum/error-ingestion/rules/update | 更新错误采集规则 |
| POST | /rum/error-ingestion/rules/delete | 删除错误采集规则 |
| POST | /rum/error-ingestion/rules/enable | 启用错误采集规则 |
| POST | /rum/error-ingestion/rules/disable | 禁用错误采集规则 |
| POST | /rum/error-ingestion/rules/history/list | 查询错误采集规则历史 |
| POST | /rum/error-ingestion/rules/history/revert | 回滚错误采集规则到历史版本 |
Issue 预设严重性规则
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /rum/issue/preset-severity/rules/list | 查询预设严重性规则列表 |
| POST | /rum/issue/preset-severity/rules/create | 创建预设严重性规则 |
| POST | /rum/issue/preset-severity/rules/update | 更新预设严重性规则 |
| POST | /rum/issue/preset-severity/rules/delete | 删除预设严重性规则 |
| POST | /rum/issue/preset-severity/rules/enable | 启用预设严重性规则 |
| POST | /rum/issue/preset-severity/rules/disable | 禁用预设严重性规则 |
| POST | /rum/issue/preset-severity/rules/reorder | 调整预设严重性规则顺序 |
| POST | /rum/issue/preset-severity/rules/history/list | 查询预设严重性规则历史列表 |
| POST | /rum/issue/preset-severity/rules/history/revert | 回滚预设严重性规则到历史版本 |
资源
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /rum/resource/info | 查看 RUM 资源信息 |
AI SRE(53 个接口)
AI SRE(53 个接口)
技能
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /safari/skill/list | 查询技能列表 |
| POST | /safari/skill/get | 查看技能详情 |
| POST | /safari/skill/update | 更新技能 |
| POST | /safari/skill/delete | 删除技能 |
| POST | /safari/skill/upload | 上传技能 |
| POST | /safari/skill/enable | 启用技能 |
| POST | /safari/skill/disable | 禁用技能 |
MCP 服务器
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /safari/mcp/server/list | 查询 MCP 服务器列表 |
| POST | /safari/mcp/server/create | 创建 MCP 服务器 |
| POST | /safari/mcp/server/get | 查看 MCP 服务器详情 |
| POST | /safari/mcp/server/update | 更新 MCP 服务器 |
| POST | /safari/mcp/server/delete | 删除 MCP 服务器 |
| POST | /safari/mcp/server/enable | 启用 MCP 服务器 |
| POST | /safari/mcp/server/disable | 禁用 MCP 服务器 |
A2A 智能体
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /safari/a2a-agent/create | 创建 A2A 智能体 |
| POST | /safari/a2a-agent/list | 查询 A2A 智能体列表 |
| POST | /safari/a2a-agent/get | 查看 A2A 智能体详情 |
| POST | /safari/a2a-agent/update | 更新 A2A 智能体 |
| POST | /safari/a2a-agent/enable | 启用 A2A 智能体 |
| POST | /safari/a2a-agent/disable | 禁用 A2A 智能体 |
| POST | /safari/a2a-agent/delete | 删除 A2A 智能体 |
会话
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /safari/session/list | 查询会话列表 |
| POST | /safari/session/get | 查看会话详情 |
| POST | /safari/session/export | 导出会话记录 |
| POST | /safari/session/delete | 删除会话 |
POST /safari/session/get 的响应在 events 之外新增 pending_messages 字段:会话队列中、Agent(Actor)尚未读取的人类消息的服务端投影,按执行顺序排列(队首在前),始终为数组(没有排队消息时是空数组,不会是 null)。每个元素的字段:| 字段 | 类型 | 说明 |
|---|---|---|
invocation_id | string | 该消息的调用 ID(发送消息时 202 回执 / user_message_enqueued 帧下发的 ID) |
client_msg_id | string | 客户端消息 ID(可选) |
person_id | int | 消息作者的成员 ID |
steering | boolean | 是否为插话消息(可选) |
query | string | 消息文本,与发送回执帧一致 |
parts | array | 消息携带的 parts(text / file / ref / skill,原样透传,可选) |
source 的内部生产者消息(自动化、子会话通知、父会话初启消息等)与提问作答(function_response)所在的消息不在其中;队列读取失败时降级为空数组,不会导致请求失败。该投影与 user_message_enqueued 帧的载荷一致,用于渲染「已发送但尚未被处理」的待处理气泡。自动化
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /safari/automation/rule/create | 创建自动化规则 |
| POST | /safari/automation/rule/list | 列出自动化规则 |
| POST | /safari/automation/rule/get | 查看自动化规则 |
| POST | /safari/automation/rule/update | 更新自动化规则 |
| POST | /safari/automation/rule/delete | 删除自动化规则 |
| POST | /safari/automation/template/list | 列出自动化模板 |
| POST | /safari/automation/run/list | 列出自动化运行历史 |
| POST | /safari/automation/rule/run | 运行自动化规则 |
知识
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /safari/knowledge/pack/list | 查询知识列表 |
| POST | /safari/knowledge/get | 查看账户知识 |
| POST | /safari/knowledge/pack/ensure | 确保知识存在 |
| POST | /safari/knowledge/pack/update | 更新知识 |
| POST | /safari/knowledge/pack/delete | 删除知识 |
| POST | /safari/knowledge/file/list | 查询知识文件列表 |
| POST | /safari/knowledge/file/get | 获取知识文件 |
| POST | /safari/knowledge/file/put | 上传知识文件 |
| POST | /safari/knowledge/file/delete | 删除知识文件 |
产物
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /safari/artifact/gallery/list | 查询产物列表 |
| POST | /safari/artifact/gallery/get | 获取产物详情 |
| POST | /safari/artifact/gallery/file-state | 查询文件发布状态 |
| POST | /safari/artifact/sign | 签发文件访问链接 |
| GET | /safari/artifact/stream | 下载或预览文件 |
| POST | /safari/artifact/gallery/publish-from-file | 发布文件为产物 |
| POST | /safari/artifact/gallery/update | 更新产物 |
| POST | /safari/artifact/gallery/delete | 从产物库移除产物 |
| POST | /safari/artifact/gallery/pin | 把产物置顶到调用者自己的画廊 |
| POST | /safari/artifact/gallery/unpin | 取消调用者自己的置顶 |
| POST | /safari/artifact/gallery/share/enable | 开启公开分享 |
| POST | /safari/artifact/gallery/share/sync | 更新公开分享快照 |
| POST | /safari/artifact/gallery/share/revoke | 撤销公开分享 |
/safari/artifact/gallery/pin 与 /safari/artifact/gallery/unpin 是新增接口,API 参考尚未生成对应页面(本表其余接口都可点入),因此上表这两行只列路径。两者都以 artifact_id(必填)为入参,成功时返回空响应,都不会改动产物本身。置顶是按调用者个人维护的偏好,不是对产物的编辑:产物仍对全账户可见,只有调用者自己看到的画廊顺序不同——产物列表把调用者置顶的产物排到前面,并在这些行上返回 pinned_at(Unix 毫秒,未置顶时不返回该字段)。任何账户成员都可以置顶自己看得到的产物;置顶要求产物存在(不存在返回 404),取消置顶不做存在性检查。两个接口都幂等:重复置顶会刷新置顶时间,取消一个从未置顶的产物也会成功。平台(28 个接口)
平台(28 个接口)
成员管理
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /member/info | 获取当前成员信息 |
| POST | /member/list | 查询成员列表 |
| POST | /member/delete | 删除成员 |
| POST | /member/invite | 邀请成员 |
| POST | /member/role/grant | 授予成员角色 |
| POST | /member/role/revoke | 解除成员角色 |
| POST | /member/role/update | 更新成员角色 |
| POST | /member/info/reset | 重置成员信息 |
| POST | /member/notify | 通知成员 |
| POST | /person/infos | 批量获取人员信息 |
团队管理
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /team/info | 查看团队详情 |
| POST | /team/infos | 批量查看团队信息 |
| POST | /team/list | 查看团队列表 |
| POST | /team/upsert | 变更团队信息 |
| POST | /team/delete | 删除团队 |
角色与权限
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /role/info | 查看角色详情 |
| POST | /role/list | 查看角色列表 |
| POST | /role/upsert | 创建或更新角色 |
| POST | /role/enable | 启用角色 |
| POST | /role/disable | 禁用角色 |
| POST | /role/delete | 删除角色 |
| POST | /role/permission/list | 查看角色权限集合 |
| POST | /role/permission/factor/list | 查看权限因子集合 |
| POST | /role/member/grant | 授予成员账户权限 |
| POST | /role/member/revoke | 解除成员账户权限 |
审计日志
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /audit/search | 检索审计日志 |
| POST | /audit/operation/list | 查看事件类型列表 |
账户设置
| 方法 | 接口 | 描述 |
|---|---|---|
| POST | /account/info | 查看主体信息 |