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

限制说明

使用说明

  • start_time 和 end_time 均为必填的 Unix 时间戳(秒)。start_time 必须小于 end_time,跨度不超过 31 天。
  • 结果会根据调用方的协作空间数据访问权限进行过滤。传了 channel_ids 但其中没有调用方可访问的协作空间时,结果为空。
  • severities 为逗号分隔的列表,按 event_severity 匹配,如 "Critical,Warning"。取值不做校验,未知值(或 Ok)不会匹配任何事件。
  • 传入上次响应中的 search_after_ctx 获取下一页;不传时按 p/limit 页码分页,且 p * limit 不超过 10,000。

授权

app_key
string
query
必填

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

请求体

application/json

全局原始事件列表的过滤和分页条件,时间范围必填。

start_time
integer<int64>
必填

查询窗口起点,Unix 时间戳(秒)。必须大于 0。

end_time
integer<int64>
必填

查询窗口终点,Unix 时间戳(秒)。必须大于 start_time;跨度不超过 31 天。

p
integer<int64> | null

页码,从 1 开始。仅在未提供 search_after_ctx 时生效。

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

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

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

分页游标:首页留空,之后传入上一次响应返回的 search_after_ctx。

integration_ids
integer<int64>[]

按集成 ID 过滤。

integration_types
string[]

按集成类型(插件键)过滤。

channel_ids
integer<int64>[]

按协作空间 ID 过滤,最多 100 个。调用方无权访问的协作空间会被去掉;一个都不剩时结果为空。

Maximum array length: 100
severities
string

按 event_severity 过滤,多个值用逗号分隔,如 Critical,Warning。有效取值:Critical、Warning、Info。取值不做校验,未知值(或 Ok)匹配不到事件。

orderby
enum<string>

排序字段,目前仅支持 event_time。

可用选项:
event_time
asc
boolean

为 true 时升序排序。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

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