API 目录 - Flashduty Docs

Flashduty Open API 提供 339 个接口，覆盖 On-call、Monitors、RUM、AI SRE 和平台五个主要模块。所有接口使用统一认证方式和请求规范。详情参见快速开始。

所有接口 URL 均以 https://api.flashcat.cloud 为 base，通过 query string 中的 APP Key 认证。

On-call（193 个接口）

故障管理

方法	接口	描述
POST	`/incident/list`	查询故障列表
POST	`/incident/info`	获取故障详情
POST	`/incident/list-by-ids`	批量查询故障
POST	`/incident/alert/list`	查询故障关联告警
POST	`/incident/feed`	获取故障时间线
POST	`/incident/past/list`	查询历史相似故障
POST	`/incident/create`	创建故障
POST	`/incident/ack`	认领故障
POST	`/incident/unack`	取消认领故障
POST	`/incident/resolve`	恢复故障
POST	`/incident/reopen`	重开故障
POST	`/incident/snooze`	暂停故障通知
POST	`/incident/wake`	恢复故障通知
POST	`/incident/merge`	合并故障
POST	`/incident/disable-merge`	禁止故障合并
POST	`/incident/reset`	更新故障信息
POST	`/incident/remove`	删除故障
POST	`/incident/comment`	评论故障
POST	`/incident/assign`	分派故障
POST	`/incident/responder/add`	添加故障处理人员
POST	`/incident/field/reset`	更新故障自定义字段
POST	`/incident/custom-action/do`	执行自定义操作
POST	`/incident/war-room/detail`	获取战情室详情
POST	`/incident/war-room/list`	查询战情室列表
POST	`/incident/war-room/create`	创建战情室
POST	`/incident/war-room/delete`	删除战情室
GET	`/incident/post-mortem/info`	获取复盘报告
POST	`/incident/post-mortem/list`	查询复盘报告列表
POST	`/incident/post-mortem/delete`	删除复盘报告
POST	`/incident/war-room/default-observers`	查看作战室默认观察者
POST	`/incident/war-room/add-member`	添加作战室成员
POST	`/incident/post-mortem/init`	初始化故障复盘
POST	`/incident/post-mortem/basics/reset`	更新故障复盘基础信息
POST	`/incident/post-mortem/status/reset`	更新故障复盘状态
POST	`/incident/post-mortem/title/reset`	更新故障复盘标题
POST	`/incident/post-mortem/follow-ups/reset`	更新故障复盘后续行动
POST	`/incident/post-mortem/content/reset`	重置故障复盘正文
POST	`/incident/post-mortem/template/upsert`	创建或更新故障复盘模板
POST	`/incident/post-mortem/template/delete`	删除故障复盘模板
POST	`/incident/post-mortem/template/list`	查询故障复盘模板列表
GET	`/incident/post-mortem/template/info`	查看故障复盘模板详情
POST	`/incident/sdp/request/list`	获取 ServiceDeskPlus 关联故障
POST	`/incident/comment-type/list`	查询评论类型列表
POST	`/incident/comment-type/create`	创建评论类型
POST	`/incident/comment-type/update`	更新评论类型
POST	`/incident/comment-type/delete`	删除评论类型
POST	`/incident/comment-type/reorder`	调整评论类型顺序
POST	`/incident/work-item/list`	查询跟进事项列表
POST	`/incident/work-item/create`	创建跟进事项
POST	`/incident/work-item/update`	更新跟进事项
POST	`/incident/work-item/delete`	删除跟进事项
POST	`/incident/work-item/complete`	完成跟进事项
POST	`/incident/work-item/convert`	转化为复盘跟进事项
POST	`/incident/work-item/assignees/reset`	重置跟进事项负责人
POST	`/incident/work-item/post-mortem/bind`	绑定跟进事项到复盘

协作空间

方法	接口	描述
POST	`/channel/info`	获取协作空间详情
POST	`/channel/list`	查询协作空间列表
POST	`/channel/infos`	批量获取协作空间
POST	`/channel/create`	创建协作空间
POST	`/channel/update`	更新协作空间
POST	`/channel/delete`	删除协作空间
POST	`/channel/enable`	启用协作空间
POST	`/channel/disable`	禁用协作空间
POST	`/channel/silence/rule/list`	查询静默策略列表
POST	`/channel/silence/rule/create`	创建静默策略
POST	`/channel/silence/rule/update`	更新静默策略
POST	`/channel/silence/rule/delete`	删除静默策略
POST	`/channel/silence/rule/enable`	启用静默策略
POST	`/channel/silence/rule/disable`	禁用静默策略
POST	`/channel/inhibit/rule/list`	查询抑制策略列表
POST	`/channel/inhibit/rule/create`	创建抑制策略
POST	`/channel/inhibit/rule/update`	更新抑制策略
POST	`/channel/inhibit/rule/delete`	删除抑制策略
POST	`/channel/inhibit/rule/enable`	启用抑制策略
POST	`/channel/inhibit/rule/disable`	禁用抑制策略
POST	`/channel/unsubscribe/rule/list`	查询排除规则列表
POST	`/channel/unsubscribe/rule/create`	创建排除规则
POST	`/channel/unsubscribe/rule/update`	更新排除规则
POST	`/channel/unsubscribe/rule/delete`	删除排除规则
POST	`/channel/unsubscribe/rule/enable`	启用排除规则
POST	`/channel/unsubscribe/rule/disable`	禁用排除规则
POST	`/channel/escalate/rule/info`	获取分派策略详情
POST	`/channel/escalate/rule/list`	查询分派策略列表
POST	`/channel/escalate/rule/create`	创建分派策略
POST	`/channel/escalate/rule/update`	更新分派策略
POST	`/channel/escalate/rule/delete`	删除分派策略
POST	`/channel/escalate/rule/enable`	启用分派策略
POST	`/channel/escalate/rule/disable`	禁用分派策略
POST	`/route/info`	获取路由规则详情
POST	`/route/list`	查询路由规则列表
POST	`/route/upsert`	创建或更新路由规则

告警管理

方法	接口	描述
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	`/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`	导出处理人员洞察

状态页

方法	接口	描述
GET	`/status-page/change/info`	获取状态页事件详情
GET	`/status-page/change/list`	查询状态页事件列表
GET	`/status-page/change/active/list`	查询状态页活跃事件列表
POST	`/status-page/change/create`	创建状态页事件
POST	`/status-page/change/update`	更新状态页事件
POST	`/status-page/change/delete`	删除状态页事件
POST	`/status-page/change/timeline/create`	创建事件时间线
POST	`/status-page/change/timeline/update`	更新事件时间线
POST	`/status-page/change/timeline/delete`	删除事件时间线
GET	`/status-page/subscriber/list`	查询状态页订阅者列表
POST	`/status-page/subscriber/import`	批量导入订阅者
POST	`/status-page/subscriber/export`	导出订阅者
POST	`/status-page/migrate-structure`	迁移状态页结构
POST	`/status-page/migrate-email-subscribers`	迁移邮件订阅者
GET	`/status-page/migration/status`	获取迁移状态
POST	`/status-page/migration/cancel`	取消状态页迁移
POST	`/status-page/draft/create`	创建状态页草稿
GET	`/status-page/list`	查询状态页列表
GET	`/status-page/info`	获取状态页详情
POST	`/status-page/create`	创建状态页
POST	`/status-page/update`	更新状态页
POST	`/status-page/delete`	删除状态页
POST	`/status-page/component/upsert`	创建或更新状态页组件
POST	`/status-page/component/delete`	删除状态页组件
POST	`/status-page/section/upsert`	创建或更新状态页区域
POST	`/status-page/section/delete`	删除状态页区域
POST	`/status-page/template/upsert`	创建或更新状态页模板
POST	`/status-page/template/delete`	删除状态页模板
GET	`/status-page/template/list`	查询状态页模板列表

变更管理

方法	接口	描述
POST	`/change/list`	查询变更列表

IM 集成

方法	接口	描述
POST	`/datasource/im/war-room-enabled/list`	查看开启作战室功能的集成

Monitors（25 个接口）

告警规则

方法	接口	描述
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/import`	导入告警规则
POST	`/monit/rule/export`	导出告警规则
POST	`/monit/rule/move`	移动告警规则到文件夹
POST	`/monit/rule/audits`	查询规则变更历史
POST	`/monit/rule/audit/detail`	查看规则审计快照
POST	`/monit/rule/counter/total`	查看规则数量时序
POST	`/monit/rule/counter/channel`	按协作空间查询规则统计

告警数据源

方法	接口	描述
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`	执行探索查询

通用工具

方法	接口	描述

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 个接口）

技能

方法	接口	描述
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/share/enable`	开启公开分享
POST	`/safari/artifact/gallery/share/sync`	更新公开分享快照
POST	`/safari/artifact/gallery/share/revoke`	撤销公开分享

平台（27 个接口）

成员管理

方法	接口	描述
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	`/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`	查看主体信息

​故障管理

​协作空间

​告警管理

​集成中心

​值班排班

​许可管理

​日历管理

​通知模板

​标签增强

​分析看板

​状态页

​变更管理

​IM 集成

​告警规则

​告警数据源

​诊断分析

​通用工具

​RUM 自定义字段

​应用管理

​RUM 问题跟踪

​RUM 会话回放

​RUM Sourcemap

​RUM 数据查询

​错误采集规则

​Issue 预设严重性规则

​资源

​技能

​MCP 服务器

​A2A 智能体

​会话

​自动化

​知识

​产物

​成员管理

​团队管理

​角色与权限

​审计日志

​账户设置

故障管理

协作空间

告警管理

集成中心

值班排班

许可管理

日历管理

通知模板

标签增强

分析看板

状态页

变更管理

IM 集成

告警规则

告警数据源

诊断分析

通用工具

RUM 自定义字段

应用管理

RUM 问题跟踪

RUM 会话回放

RUM Sourcemap

RUM 数据查询

错误采集规则

Issue 预设严重性规则

资源

技能

MCP 服务器

A2A 智能体

会话

自动化

知识

产物

成员管理

团队管理

角色与权限

审计日志

账户设置