跳转到主要内容
POST
更新故障信息

限制说明

使用说明

  • 至少要传一个字段。未传的字段和空字符串都保持原值,因此本接口无法清空字段。
  • 与当前值相同的字段会被跳过。每个发生变化的字段各写一条时间线记录(i_r_title、i_r_desc、i_r_impact、i_r_rc、i_r_rsltn 或 i_r_severity)。
  • 修改 title、description 或 incident_severity 会把该字段加入 manual_overrides,此后合并进来的告警不再覆盖它。
  • 已关闭的故障同样可以更新。

授权

app_key
string
query
必填

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

请求体

application/json

要更新的故障字段。除 incident_id 外至少要有一个非空字段;未传或为空的字段保持原值。

incident_id
string
必填

故障 ID(MongoDB ObjectID)。

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

新标题。

Required string length: 3 - 200
description
string

新描述。

Required string length: 3 - 6144
impact
string

新影响描述。

Required string length: 3 - 6144
root_cause
string

新根因分析。

Required string length: 3 - 6144
resolution
string

新解决方案说明。

Required string length: 3 - 6144
incident_severity
enum<string>

新严重程度:Info 提示、Warning 警告、Critical 严重。

可用选项:
Info,
Warning,
Critical

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

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