跳转到主要内容
POST
/
alert
/
list
查询告警列表
curl --request POST \
  --url 'https://api.flashcat.cloud/alert/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_time": 1712620800,
  "end_time": 1712707200,
  "limit": 20,
  "is_active": true
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 1,
    "has_next_page": false,
    "search_after_ctx": "",
    "items": [
      {
        "alert_id": "663a1b2c3d4e5f6789abcdef",
        "integration_id": 10001,
        "channel_id": 20001,
        "account_id": 10023,
        "title": "CPU 使用率 > 90%",
        "alert_severity": "Critical",
        "alert_status": "Critical",
        "start_time": 1712650000,
        "last_time": 1712655000,
        "end_time": 0,
        "labels": {
          "host": "web-01"
        },
        "ever_muted": false,
        "created_at": 1712650000,
        "updated_at": 1712655000,
        "integration_name": "Prometheus",
        "integration_type": "prometheus",
        "channel_name": "生产",
        "event_cnt": 3
      }
    ]
  }
}

限制说明

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

使用说明

  • start_timeend_time 均为必填的 Unix 时间戳(秒),最大跨度 31 天。
  • 使用上次响应中的 search_after_ctx 获取下一页。
  • 结果会根据调用方的协作空间数据访问权限进行过滤。
  • is_active 设为 true 可仅返回活跃(触发中)告警;设为 false 返回已恢复告警。

授权

app_key
string
query
必填

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

请求体

application/json

告警列表查询的过滤和分页条件,时间范围必填。

start_time
integer<int64>
必填

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

end_time
integer<int64>
必填

检索窗口结束时间,Unix 时间戳(秒)。最大跨度 31 天。

p
integer<int64>

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

limit
integer<int64>

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

search_after_ctx
string

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

is_active
boolean

过滤活跃(true)或已恢复(false)状态告警。

ever_muted
boolean

按告警是否曾被静默过滤。

alert_severity
string

逗号分隔的严重程度过滤,如 Critical,Warning。可选值:CriticalWarningInfoOk

channel_ids
integer<int64>[]

按协作空间 ID 过滤。

integration_ids
integer<int64>[]

按集成 ID 过滤。

alert_ids
string[]

按告警 ID(ObjectID 十六进制字符串)过滤。

alert_keys
string[]

按告警去重键过滤。

orderby
enum<string>

排序字段。

可用选项:
created_at,
updated_at
asc
boolean

为 true 时升序排序,默认降序。

by_updated_at
boolean

为 true 时,时间范围过滤作用于 updated_at 而非 start_time

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

分页的告警列表。