跳转到主要内容
POST
创建或更新故障复盘模板

限制说明

使用说明

  • 需要 On-call Pro 许可。
  • 省略 template_id 表示创建:team_id 必须是已存在的团队,模板 ID 由服务端生成。
  • 传 template_id 表示替换已有自定义模板;ID 不存在时返回 ResourceNotFound。更新需为账户所有者或管理员,或是模板所属团队的成员。
  • 所有文本字段整体替换:省略的 description 或 content_markdown 会变为空。更新时传 team_id 会把模板移到该团队;省略或传 0 则保持当前团队。
  • 内置模板(post_mortem_default_tmpl_*)不可修改。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

创建或更新故障复盘模板的参数。

name
string
必填

控制台中显示的模板名称。

content
string
必填

模板正文,为序列化成字符串的 BlockNote 编辑器 JSON(块数组)。基于该模板创建的报告以此为初始正文。

template_id
string

要替换的自定义模板 ID。省略表示创建新模板(ID 由服务端生成)。

team_id
integer<int64>

管理团队 ID。创建时必填,且团队必须存在。更新时传入不同的团队 ID 会迁移模板;省略或传 0 保持当前团队。

description
string

模板描述;省略时为空。

content_markdown
string

正文的 Markdown 版本,AI 生成报告时作为提纲使用。省略时为空。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

故障复盘报告模板。