跳转到主要内容
POST
创建跟进事项

限制说明

使用说明

  • 需要 On-call Pro 许可。
  • action:故障不能已关闭,调用方须有该故障的编辑权限,且不得设置 post_mortem_id。
  • follow_up:故障必须已关闭。传 post_mortem_id 时,调用方须有该复盘的编辑权限,且故障须已关联到该复盘;不传时,调用方须有故障的编辑权限,若故障已有复盘则服务端自动绑定,否则事项保持未绑定,直到创建复盘。
  • assignees(每项为 {type, id?},type 取 person 或 ai_sre,ai_sre 不带 id)与旧版 assignee_ids(全部为 person)二选一,同时传入会报错。
  • 人员负责人须为已能查看该故障或复盘的活跃成员 —— 指派不会授予访问权限。
  • 新添加的人员负责人会收到通知;指派 ai_sre 会启动一个 AI SRE 会话来处理该事项。
  • 同一调用方用相同 idempotency_key 重试时,返回原事项并标记 idempotent_replay: true;若原事项已被删除,返回 RequestLocked。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json

创建故障跟进事项的参数。

item_type
enum<string>
必填

事项类型。

  • action:未关闭故障上的待办,不得设置 post_mortem_id。
  • follow_up:已关闭故障上的复盘后续行动,post_mortem_id 可选。
可用选项:
action,
follow_up
title
string
必填

事项标题,最多 512 个字符;首尾空白会被去除,且不能为空。

Maximum string length: 512
incident_id
string
必填

事项锚定的故障 ID(MongoDB ObjectID)。

Pattern: ^[0-9a-fA-F]{24}$
idempotency_key
string
必填

客户端生成的幂等键(最长 128 字符;仅限字母、数字、_、-、.、:)。

Maximum string length: 128
Pattern: ^[A-Za-z0-9_\-.:]+$
description
string

可选的详细描述(最长 65,535 字符)。

Maximum string length: 65535
status
enum<string>

可选,客户端自定义的初始状态,取 open、in_progress、done、cancelled 之一;省略或为空时默认为 open。

可用选项:
open,
in_progress,
done,
cancelled
Maximum string length: 64
priority
string

可选的优先级,自由文本,最多 64 个字符。控制台使用 high、medium、low;其他字符串会原样保存。

Maximum string length: 64
post_mortem_id
string

复盘 ID(32 位十六进制字符串)。action 不得设置。follow_up 可选:设置时故障须已关联到该复盘;省略时若故障已有复盘则自动使用。

assignee_ids
integer<int64>[]

初始负责人的旧版别名,等价于全部为 person 的 assignees。与 assignees 互斥,同时出现会报错。负责人须为已能查看锚定对象的活跃成员;指派不会授予访问权限。

Maximum array length: 20
assignees
object[]

初始负责人列表。每项为 {type, id?}。type 取 person 或 ai_sre;ai_sre 不带 id。与 assignee_ids 互斥,同时出现会报错。assignee_ids 是旧版别名,等价于全部为 person。最多 20 项。person 须为已能查看锚定对象的活跃成员;指派不会授予访问权限。

Maximum array length: 20

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

创建跟进事项的结果。