跳转到主要内容
POST
/
alert-event
/
list
查询原始告警事件列表
curl --request POST \
  --url 'https://api.flashcat.cloud/alert-event/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_time": 1712620800,
  "end_time": 1712707200,
  "limit": 20,
  "severities": "Critical"
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 1,
    "has_next_page": false,
    "items": [
      {
        "event_id": "663a1b2c3d4e5f6789abc001",
        "alert_id": "663a1b2c3d4e5f6789abcdef",
        "title": "CPU 使用率 > 90%",
        "event_severity": "Critical",
        "event_time": 1712650000
      }
    ]
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求协作空间查看on-call

使用说明

  • 结果会根据调用方的协作空间数据访问权限进行过滤。
  • severities 为逗号分隔的字符串,如 "Critical,Warning"

授权

app_key
string
query
必填

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

请求体

application/json

全局原始事件列表的过滤和分页条件。

start_time
integer<int64>

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

end_time
integer<int64>

检索窗口结束时间,Unix 时间戳(秒)。

p
integer<int64>

页码,从 1 开始。未提供 search_after_ctx 时使用。

limit
integer<int64>

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

search_after_ctx
string

下一页的不透明游标。

integration_ids
integer<int64>[]

按集成 ID 过滤。

integration_types
string[]

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

channel_ids
integer<int64>[]

按协作空间 ID 过滤,最多 100 个。

severities
string

逗号分隔的严重程度过滤,如 Critical,Warning

orderby
enum<string>

排序字段(ES 字段名)。

可用选项:
event_time
asc
boolean

为 true 时升序排序。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

每个接口自己的业务 payload,详见各接口的 200 响应 schema。