跳转到主要内容
POST
查询故障列表

限制说明

使用说明

  • 只返回调用者有权访问的协作空间中的故障。
  • start_time 和 end_time 按故障开始时间过滤,跨度最多 31 天。start_time 早于账户数据保留期时会被调整到保留期起点;end_time 早于该起点时返回 InvalidParameter。
  • 结果按 start_time 排序,默认最新在前,asc 为 true 时最早在前。
  • 可用 p 和 limit 分页,也可传入上次响应的 search_after_ctx,此时忽略 p。
  • total 最多为 1,000。has_next_page 不依赖 total:按 p/limit 分页和游标模式下都如实反映是否还有更多数据,超过 1,000 条也一样。每个非空页还会返回 search_after_ctx,可用于游标分页。
  • 不传 progress 时返回所有处理进度的故障。

授权

app_key
string
query
必填

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

请求体

application/json

查询故障列表的过滤条件。start_time 与 end_time 必填,时间窗口不超过 31 天。

start_time
integer<int64>
必填

时间窗口起点(Unix 秒)。与 end_time 构成的窗口最长 31 天,按故障发生时间过滤。

end_time
integer<int64>
必填

时间窗口终点(Unix 秒),必须大于 start_time 且不超过 31 天。

asc
boolean

true 为升序。

is_snoozed
boolean

true 时仅返回已暂停通知的故障。

is_my_team
boolean

true 时仅返回用户所属团队管理的协作空间中的故障。

is_my_channel
boolean

true 时仅返回用户个人管理的协作空间中的故障。

ever_muted
boolean

true 时仅返回曾被静默的故障。

is_rare
boolean

true 时仅返回新奇故障。

has_unfinished_work_item
boolean

为 true 时只返回仍有状态既不是 done 也不是 cancelled 的行动项或后续行动的故障。false 不做过滤。

progress
string

要匹配的处理进度,多个值用英文逗号分隔,例如 Triggered,Processing。取值:Triggered 未认领;Processing 已认领处理中;Closed 已关闭。不传时匹配全部进度。

query
string

全文搜索关键词。

incident_severity
string

要匹配的严重程度,多个值用英文逗号分隔,例如 Critical,Warning。取值:Critical 严重、Warning 警告、Info 提醒。

channel_ids
integer<int64>[]

协作空间 ID 列表,0 表示独立故障。

team_ids
integer<int64>[]

团队 ID 列表,通过协作空间所属团队进行解析。

responder_ids
integer<int64>[]

按处理人过滤,取值为成员 ID,可通过 POST /member/list 获取。

acker_ids
integer<int64>[]

按认领人过滤,取值为成员 ID,可通过 POST /member/list 获取。

creator_ids
integer<int64>[]

创建人员成员 ID,0 表示自动创建。

closer_ids
integer<int64>[]

关闭人员成员 ID,0 表示自动关闭。

incident_ids
string[]

指定故障 ID 列表进行过滤。单次请求最多 100 项,更多请分多次调用。

Maximum array length: 100
nums
string[]

按故障短编号过滤,即控制台故障标题前展示的编号。单次请求最多 100 项,更多请分多次调用。

Maximum array length: 100
p
integer<int64>

页码,从 1 开始。

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

分页大小,最大 100。 按页码翻页时,p × limit 不能超过 10,000。

必填范围: 0 <= x <= 100
search_after_ctx
string

上次响应返回的 search_after_ctx 游标;设置后忽略 p。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

故障分页列表。