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

限制说明

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

使用说明

  • 默认按最新事件优先返回;设置 asc=true 可按最早事件优先读取。
  • 使用上次响应中的 search_after_ctx 搭配 limit 获取下一页。
  • 也支持通过 p 使用页码分页,但 p * limit 必须在 10,000 条以内。
  • 单条告警可能累积大量原始事件,热点告警建议优先使用游标分页。

授权

app_key
string
query
必填

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

请求体

application/json
alert_id
string
必填

告警 ID(MongoDB ObjectID)。

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

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

limit
integer<int64>
默认值:20

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

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

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

必填范围: x >= 0
search_after_ctx
string

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

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
必填

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