跳转到主要内容
POST
评论故障

限制说明

使用说明

  • 要提及成员,在 comment 中嵌入形如 [@显示名](flashduty://ref/member/<member_id>) 的 markdown 链接。被提及的成员会收到专门的个人通知,不受 mute_reply 影响。
  • 不带链接语法的纯 @名字 文本不会形成提及。
  • 服务端会将每个提及的显示名改写为成员的规范名称。

授权

app_key
string
query
必填

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

请求体

application/json

为故障添加评论的参数。

incident_ids
string[]
必填

目标故障 ID 列表,单次最多 100 条。

Required array length: 1 - 100 elements
Pattern: ^[0-9a-fA-F]{24}$
comment
string
必填

评论内容。首尾空白会被去除;去除后必须非空,且最多 1024 字符(按 @提及归一化后计数)。

Maximum string length: 1024
mute_reply
boolean

为 true 时不触发 webhook 回复动作。

comment_type_id
string | null

可选,附加到评论的账户级评论类型 ID(MongoDB ObjectID)。无效或全零 ID 将返回 400。

Pattern: ^[0-9a-fA-F]{24}$

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

无返回数据。不同接口的 data 可能是 {},也可能不出现在响应中;请只根据 HTTP 200 且没有 error 判断成功。