跳转到主要内容
POST
获取故障时间线

限制说明

使用说明

  • 对于 i_comm 条目,detail.comment_type 在读取时根据当前账户级评论类型定义解析,因此始终反映类型的最新名称和颜色。
  • 只返回记录在故障本身上的条目;告警级别的条目请通过告警相关接口查询。
  • 条目按创建时间排序,默认最新在前,asc 为 true 时最早在前。通过 p 和 limit 分页;has_next_page 表示是否还有下一页,不返回总数。
  • 对于 i_notify 条目,failed_reason 是读取时填充的本地化投递失败原因。

授权

app_key
string
query
必填

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

请求体

application/json

获取故障时间线的参数。

incident_id
string
必填

故障 ID(MongoDB ObjectID)。

Pattern: ^[0-9a-fA-F]{24}$
p
integer<int64>
默认值:1

页码,从 1 开始。

必填范围: x >= 1
limit
integer<int64>
默认值:20

分页大小,最大 100。

必填范围: 1 <= x <= 100
asc
boolean

true 为按时间升序。

types
enum<string>[]

只返回这些类型的条目;不传时返回全部类型。

故障时间线条目类型。每个值对应一个生命周期事件,其 detail 载荷结构由该字段决定。故障级事件前缀为 i_;向上冒泡到故障时间线的告警级事件前缀为 a_。

可用选项:
i_new,
i_assign,
i_a_rspd,
i_notify,
i_storm,
i_snooze,
i_wake,
i_ack,
i_unack,
i_comm,
i_rslv,
i_reopen,
i_merge,
i_r_title,
i_r_desc,
i_r_impact,
i_r_rc,
i_r_rsltn,
i_r_severity,
i_r_field,
i_m_flapping,
i_m_reply,
i_custom,
i_wr_create,
i_wr_delete,
i_auto_refresh,
i_wi_created,
i_wi_updated,
i_wi_assignees,
i_wi_completed,
i_wi_converted,
i_wi_bound,
i_wi_deleted,
i_wi_auto_converted,
a_merge

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

故障时间线分页结果。