跳转到主要内容
POST
查询告警列表

限制说明

使用说明

  • start_time 和 end_time 为必填的 Unix 时间戳(秒),按告警的 start_time 过滤,跨度不超过 31 天。
  • by_updated_at 为 true 时,在 start_time 过滤之外再按相同区间过滤 updated_at,且跨度不超过 7 天。
  • start_time 早于账户数据保留期时会被调整为保留期起点;end_time 早于该起点时返回 InvalidParameter。
  • 传入上次响应中的 search_after_ctx 获取下一页;不传时按 p/limit 页码分页,且 p * limit 不超过 10,000。
  • total 最多为 1,000。has_next_page 不依赖 total:页码模式和游标模式下都准确,超过 1,000 条也一样。每个非空页都会返回最后一条告警的 search_after_ctx;要越过页码模式 10,000 条的上限,请传回该值继续读取。
  • 结果会根据调用方的协作空间数据访问权限进行过滤。
  • 将 is_active 设为 true 可仅返回活跃(触发中)告警;设为 false 返回已恢复告警。

授权

app_key
string
query
必填

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

请求体

application/json

告警列表查询的过滤和分页条件,时间范围必填。

start_time
integer<int64>
必填

查询窗口起点,Unix 时间戳(秒),作用于告警的 start_time。早于账户数据保留期时会被调整为保留期起点。

end_time
integer<int64>
必填

查询窗口终点,Unix 时间戳(秒)。必须大于 start_time,跨度不超过 31 天(启用 by_updated_at 时不超过 7 天)。早于数据保留期起点时返回 InvalidParameter。

p
integer<int64> | null

页码,从 1 开始。仅在未提供 search_after_ctx 时生效;p * limit 不能超过 10,000 条。

必填范围: x >= 0
limit
integer<int64> | null

每页条数,最大 100,默认 20。

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

上一页响应返回的分页游标,用于获取下一页。

is_active
boolean | null

按生命周期过滤:true 只返回未恢复告警(状态 Critical/Warning/Info),false 只返回已恢复告警(状态 Ok)。不传或传 null 返回全部。

ever_muted
boolean | null

按告警是否曾被静默过滤。

alert_severity
string

按 alert_severity 过滤,多个值用逗号分隔,如 Critical,Warning。允许的取值:Critical、Warning、Info、Ok,其他值返回 InvalidParameter。alert_severity 不会是 Ok,因此 Ok 匹配不到告警。

channel_ids
integer<int64>[]

按协作空间 ID 过滤。

integration_ids
integer<int64>[]

按集成 ID 过滤。

alert_ids
string[]

只查询指定告警 ID(ObjectID 十六进制字符串)。非法 ID 会被忽略;全部非法时结果为空。单次请求最多 100 项,更多请分多次调用。

Maximum array length: 100
alert_keys
string[]

按告警去重键过滤。单次请求最多 100 项,更多请分多次调用。

Maximum array length: 100
asc
boolean

为 true 时按 start_time 升序排序;默认降序。

by_updated_at
boolean

为 true 时,在按 start_time 过滤之外,还要求告警的 updated_at 落在 [start_time, end_time] 内;此时跨度不超过 7 天。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

分页的告警列表。