跳转到主要内容
POST
查询 Webhook 推送历史

限制说明

使用说明

  • start_time 和 end_time 为 Unix 毫秒时间戳。
  • 每条记录对应一个事件向一个地址的一次推送;attempt 为 HTTP 尝试次数,仅在连接错误时重试。
  • 保存的请求与响应 Header 和 Body 会被截断。
  • 传入上次响应中的 search_after_ctx 获取下一页;最后一页时它为空字符串。
  • 部署未开启推送历史记录时返回 InvalidParameter。

授权

app_key
string
query
必填

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

请求体

application/json

出站 Webhook 推送历史的筛选参数。查询必须指定毫秒级的时间窗口;使用 search_after_ctx 进行游标分页。

limit
integer
必填

每页记录数,1–100。

必填范围: 1 <= x <= 100
start_time
integer<int64>
必填

时间窗口起始时间(Unix 毫秒)。

必填范围: 1000000000000 <= x <= 9999999999999
end_time
integer<int64>
必填

时间窗口结束时间(Unix 毫秒),必须大于 start_time。

必填范围: 1000000000000 <= x <= 9999999999999
search_after_ctx
string

上一次调用返回的不透明游标,用于获取下一页。

asc
boolean

为 true 时按 event_time 升序排序,否则降序。

orderby
enum<string>

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

可用选项:
event_time
ref_id
string

按引用 ID 过滤(故障或告警 ID)。

Maximum string length: 128
integration_id
integer<int64>

按 Webhook 集成 ID 过滤;为 0 或不传时返回全部集成。

必填范围: x >= 0
event_types
string[]

按事件类型过滤,取值为动态类型代码(如 i_new 故障创建、a_new 告警触发)。

status
enum<string>

按投递状态过滤:success 成功,failed 失败。

可用选项:
success,
failed

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

分页的 Webhook 推送历史。