跳转到主要内容
Flashduty Open API 共提供 214 个接口，覆盖 On-call、Monitors、RUM 和平台四大模块。所有接口使用统一的认证方式和请求规范，详见快速入门。
所有接口 Endpoint 均为 https://api.flashcat.cloud，使用 APP Key 通过 query string 认证。

​
故障管理

方法接口描述
POST/incident/list查询故障列表
POST/incident/info获取故障详情
POST/incident/list-by-ids批量查询故障
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/remove删除故障
POST/incident/assign分派故障
POST/incident/responder/add添加故障处理人员
POST/incident/reset更新故障信息
POST/incident/comment评论故障
POST/incident/field/reset更新故障自定义字段
POST/incident/custom-action/do执行自定义操作
POST/incident/alert/list查询故障关联告警
POST/incident/feed获取故障时间线
POST/incident/past/list查询历史相似故障
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/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/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/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/notify/rule/list查询通知规则列表
POST/channel/notify/rule/create创建通知规则
POST/channel/notify/rule/update更新通知规则
POST/channel/notify/rule/delete删除通知规则
POST/channel/notify/rule/enable启用通知规则
POST/channel/notify/rule/disable禁用通知规则

​
告警管理

方法接口描述
POST/alert/list查询告警列表
POST/alert/info查看告警详情
POST/alert/list-by-ids批量查询告警
POST/alert/event/list查询告警事件列表
POST/alert/feed查询告警动态
POST/alert-event/list查询原始告警事件列表
POST/alert/merge将告警合并到故障
POST/alert/pipeline/info查看告警处理规则
POST/alert/pipeline/list批量查询告警处理规则
POST/alert/pipeline/upsert创建或更新告警处理规则

​
集成中心

方法接口描述
POST/webhook/history/list查询 Webhook 推送历史
POST/webhook/history/detail获取 Webhook 推送详情

​
路由规则

方法接口描述
POST/route/info获取路由规则详情
POST/route/list查询路由规则列表
POST/route/upsert创建或更新路由规则

​
值班排班

方法接口描述
POST/schedule/list查询值班表列表
POST/schedule/info获取值班表详情
POST/schedule/infos批量获取值班表
POST/schedule/create创建值班表
POST/schedule/update更新值班表
POST/schedule/delete删除值班表
POST/schedule/preview预览值班表
POST/schedule/self查询我的值班表

​
日历管理

方法接口描述
POST/calendar/list查询服务日历列表
POST/calendar/info获取服务日历详情
POST/calendar/create创建服务日历
POST/calendar/update更新服务日历
POST/calendar/delete删除服务日历
POST/calendar/event/list查询日历事件列表
POST/calendar/event/upsert创建或更新日历事件
POST/calendar/event/delete删除日历事件

​
通知模板

方法接口描述
POST/template/list查询模板列表
POST/template/info查看模板详情
POST/template/create创建模板
POST/template/update更新模板
POST/template/delete删除模板

​
标签增强

方法接口描述
POST/enrichment/list批量查询富化规则
POST/enrichment/info查看富化规则
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/insight/account查看账户级别洞察
POST/insight/team查看团队洞察
POST/insight/channel查看协作空间洞察
POST/insight/responder查看处理人员洞察
POST/insight/incident/list查询洞察故障列表
POST/insight/alert/topk-by-label查看按 check/resource 聚合的 Top-K 告警
POST/insight/incident/export导出洞察故障
POST/insight/team/export导出团队洞察
POST/insight/channel/export导出协作空间洞察
POST/insight/responder/export导出处理人员洞察

​
状态页

方法接口描述
GET/status-page/change/list查询状态页事件列表
GET/status-page/change/info获取状态页事件详情
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/monit/rule/list/basic查询告警规则列表
POST/monit/rule/info查看告警规则详情
POST/monit/rule/create创建告警规则
POST/monit/rule/update更新告警规则
POST/monit/rule/delete删除告警规则
POST/monit/rule/delete/batch批量删除告警规则
POST/monit/rule/import导入告警规则
POST/monit/rule/export导出告警规则
POST/monit/rule/move移动告警规则到文件夹
POST/monit/rule/update/fields批量更新规则字段
POST/monit/rule/audits查询规则变更历史
POST/monit/rule/audit/detail查看规则审计快照
POST/monit/rule/counter/total查看规则数量时序
POST/monit/rule/counter/node按文件夹节点查询规则统计
POST/monit/rule/counter/status查看顶层文件夹规则状态统计
POST/monit/rule/counter/channel按协作空间查询规则统计
POST/monit/rule/status查看文件夹下规则触发状态
POST/monit/rule/dstypes查询可用的数据源类型

​
告警数据源

方法接口描述
POST/monit/datasource/list查询数据源列表
POST/monit/datasource/info查看数据源详情
POST/monit/datasource/create创建数据源
POST/monit/datasource/update更新数据源
POST/monit/datasource/delete删除数据源
POST/monit/datasource/sls/projects查询 SLS 项目列表
POST/monit/datasource/sls/logstores查询 SLS 日志库列表

​
规则集

方法接口描述
POST/monit/store/ruleset/list查询规则集列表
POST/monit/store/ruleset/info查看规则集详情
POST/monit/store/ruleset/create创建规则集
POST/monit/store/ruleset/update更新规则集
POST/monit/store/ruleset/delete删除规则集

​
应用管理

方法接口描述
POST/rum/application/list查询应用列表
POST/rum/application/info查看应用详情
POST/rum/application/infos批量查询应用详情
POST/rum/application/create创建应用
POST/rum/application/update更新应用
POST/rum/application/delete删除应用

​
问题跟踪

方法接口描述
POST/rum/issue/list查询 Issue 列表
POST/rum/issue/info查看 Issue 详情
POST/rum/issue/update更新 Issue

​
Sourcemap

方法接口描述
POST/sourcemap/list查询 Sourcemap 列表

​
成员管理

方法接口描述
POST/member/list查询成员列表
POST/member/info获取当前成员信息
POST/member/invite邀请成员
POST/member/delete删除成员
POST/member/info/reset重置成员信息
POST/member/role/update更新成员角色
POST/member/role/grant授予成员角色
POST/member/role/revoke解除成员角色
POST/person/infos批量获取人员信息

​
团队管理

方法接口描述
POST/team/list查看团队列表
POST/team/info查看团队详情
POST/team/infos批量查看团队信息
POST/team/upsert变更团队信息
POST/team/delete删除团队

​
角色与权限

方法接口描述
POST/role/list查看角色列表
POST/role/info查看角色详情
POST/role/upsert创建或更新角色
POST/role/delete删除角色
POST/role/enable启用角色
POST/role/disable禁用角色
POST/role/permission/list查看角色权限集合
POST/role/permission/factor/list查看权限因子集合
POST/role/member/grant授予成员账户权限
POST/role/member/revoke解除成员账户权限

​
审计日志

方法接口描述
POST/audit/search检索审计日志
POST/audit/operation/list查看事件类型列表