跳转到主要内容
ZStack
告警与响应相关接口/告警事件

查询告警列表

列表告警实例分页支持。

GET/api/v1/alerting/alerts

操作 ID

ListAlerts

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • page
    Integer

    页码。默认值为 `1`。

    示例： 0

  • pageSize
    Integer

    每页返回的记录数。

    示例： 0

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • items
    List

    条目列表。

    示例： (nested array)

    • uuid
      String

      资源的UUID，唯一标识该资源。

      示例： alert-789xyz

    • ruleUuid
      String

      规则UUID。

      示例： rule-abc123-def456

    • ruleName
      String

      规则名称。

      示例： High CPU Usage

    • resourceType
      String

      资源类型。

      示例： vm

    • resourceUuid
      String

      资源UUID。若指定，资源会使用该字段值作为UUID。

      示例： res-abc123

    • metricName
      String

      监控项名称。

      示例： cpu_usage_percent

    • currentValue
      Long

      当前值。

      示例： 95.3

    • threshold
      Long

      阈值。

      示例： 90

    • operator
      String

      比较运算符。

      示例： >

    • severity
      String

      告警级别。

      示例： critical

    • state
      String

      当前状态。

      示例： firing

    • message
      String

      错误返回消息。

      示例： CPU usage is 95.3%, exceeding threshold of 90%

    • fingerprint
      String

      指纹标识。

      示例： fp-abc123def456

    • source
      String

      来源信息。

      示例： prometheus

    • notifiedAt
      String

      已通知时间。

      示例： 2026-01-15T08:00:00Z

    • resolvedAt
      String

      已解析时间。

      示例： 2026-01-15T08:00:00Z

    • acknowledgedBy
      String

      用户由已确认告警。

      示例： admin

    • acknowledgedAt
      String

      已确认时间。

      示例： 2026-01-15T08:00:00Z

    • createDate
      String

      创建时间。

      示例： 2026-01-15T08:00:00Z

  • total
    Integer

    返回结果总数。

    示例： 42

  • limit
    Integer

    最大返回条目数。

    示例： 20

  • offset
    Integer

    查询起始偏移量。

    示例： 20