Skip to main content
POST
查询告警列表

限制说明

使用说明

  • start_timeend_time 均为必填的 Unix 时间戳(秒),最大跨度 31 天。
  • 使用上次响应中的 search_after_ctx 获取下一页。
  • 结果会根据调用方的协作空间数据访问权限进行过滤。
  • is_active 设为 true 可仅返回活跃(触发中)告警;设为 false 返回已恢复告警。

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

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

start_time
integer<int64>
必填

检索窗口开始时间,Unix 时间戳(秒)。

end_time
integer<int64>
必填

查询窗口终点,Unix 时间戳(秒)。必须大于 start_time;跨度不超过 31 天,且需在账户数据保留期内。

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

逗号分隔的严重程度过滤,如 Critical,Warning。可选值:CriticalWarningInfoOk

channel_ids
integer<int64>[]

按协作空间 ID 过滤。

integration_ids
integer<int64>[]

按集成 ID 过滤。

alert_ids
string[]

只查询指定告警 ID(ObjectID 十六进制字符串)。非法 ID 会被忽略;全部非法时结果为空。

alert_keys
string[]

按告警去重键过滤。

asc
boolean

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

by_updated_at
boolean

为 true 时,时间范围过滤作用于 updated_at 而非 start_time

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

分页的告警列表。