跳转到主要内容
POST
获取故障详情

限制说明

使用说明

  • num 不唯一,多个故障共用同一编号时返回最新的那个。建议优先使用 incident_id。
  • 本接口不填充 alerts 和 account_* 字段。告警请使用 POST /incident/alert/list,时间线请使用 POST /incident/feed。
  • images 中以 img_ 开头的图片令牌会被替换为下载地址。
  • 故障不存在时返回 InvalidParameter。

授权

app_key
string
query
必填

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

请求体

application/json

单个故障查询参数。incident_id 与 num 二者择一传入。

incident_id
string

故障 ID(MongoDB ObjectID)。

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

故障短 ID(界面上展示的 6 位大写 ID)。不唯一——命中多个时返回最近一个。incident_id 与 num 二者择一传入。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

故障详细信息。