跳转到主要内容
POST
完成跟进事项

限制说明

使用说明

  • 需要 On-call Pro 许可。
  • target_status 必须为 done。
  • 仅当前人员负责人可以完成事项(账户所有者和管理员不会被视为负责人);指派给 AI SRE 的事项也可由处理它的 AI SRE 会话完成。调用方还须有该故障或复盘的查看权限。
  • follow_up 事项仅在其故障已关闭时可修改。
  • 用相同的 idempotency_key 重复调用会返回该事项并标记 idempotent_replay: true。
  • 乐观锁 —— version 必须等于事项当前版本;不一致时返回 RequestLocked(HTTP 423),请重新读取事项后重试。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json

完成跟进事项的参数。

work_item_id
string
必填

跟进事项 ID(不透明字符串,最长 128 字符)。

Maximum string length: 128
version
integer<int64>
必填

事项当前版本号,用于乐观锁。必须与存储的版本一致。

target_status
enum<string>
必填

要设置的目标状态,必须为 done,其他取值一律拒绝。

可用选项:
done
Maximum string length: 64
idempotency_key
string
必填

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

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

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

跟进事项变更结果。删除操作不返回 item。