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

限制说明

使用说明

  • 默认按最新事件优先返回;设置 asc=true 可按最早事件优先读取。
  • 使用上次响应中的 search_after_ctx 搭配 limit 获取下一页。
  • 也支持通过 p 使用页码分页,但 p * limit 必须在 10,000 条以内。
  • 账户中不存在的 alert_id 返回 InvalidParameter。

授权

app_key
string
query
必填

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

请求体

application/json
alert_id
string
必填

告警 ID(MongoDB ObjectID)。

Pattern: ^[0-9a-fA-F]{24}$
asc
boolean
默认值:false

为 true 时按最早事件优先返回;默认按最新事件优先返回。

limit
integer<int64> | null
默认值:20

分页大小,默认 20,最大 100。

必填范围: 0 <= x <= 100
p
integer<int64> | null
默认值:1

页码,从 1 开始;未传 search_after_ctx 时生效。

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

上一页响应返回的游标;传入后使用游标分页而非页码分页。

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

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

接口返回的数据,格式见各接口的 200 响应。没有返回数据的接口会返回 {} 或完全不带 data。