跳转到主要内容
POST
恢复故障

限制说明

使用说明

  • 关闭表单生效时,custom_fields、summary 和 images 必须符合其中可见元素及必填规则。
  • 批量操作只有在全部选中的故障解析到同一张表单时才接受表单值;否则请逐条关闭。
  • 旧字段 values 和 custom_values 会被拒绝,请使用 custom_fields。
  • 已关闭的故障会被跳过,不报错;存在不认识的故障 ID 时整个请求返回 InvalidParameter。
  • 关闭处于 Triggered 的故障时,会先以调用者身份自动认领。
  • 关闭后,故障下未完成的行动项会转为后续行动,之后到达的事件也不再合并进该故障已有的告警。

授权

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}$
root_cause
string | null

可选,应用到所有故障的根因说明。

Maximum string length: 1024
resolution
string | null

可选,应用到所有故障的解决方案说明。

Maximum string length: 1024
description
string | null

新的故障描述,最多 6,144 个字符。提供后会在故障关闭前替换当前描述。

Maximum string length: 6144
custom_fields
object

解决表单的自定义字段值。允许的字段和值取决于该故障当前可见的表单。

images
object[]

附加到解决故障时间线记录的图片。

summary
string

写入时间线评论的表单摘要。仅在解决表单包含摘要元素时接受。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

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