跳转到主要内容
API Explorer|API Explorer
告警与响应相关接口/告警事件
GETAlerting起始版本 1.0同步需要认证

查询告警列表

列表告警实例分页支持。

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

查询参数

请求参数

查询参数

  • pageInteger

    页码。默认值为 `1`。

    示例： 0

  • pageSizeInteger

    每页返回的记录数。

    示例： 0

响应状态

200 OK

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

  • itemsList

    条目列表。

    示例： (nested array)

    • uuidString

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

      示例： alert-789xyz

    • ruleUuidString

      规则UUID。

      示例： rule-abc123-def456

    • ruleNameString

      规则名称。

      示例： High CPU Usage

    • resourceTypeString

      资源类型。

      示例： vm

    • resourceUuidString

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

      示例： res-abc123

    • metricNameString

      监控项名称。

      示例： cpu_usage_percent

    • currentValueLong

      当前值。

      示例： 95.3

    • thresholdLong

      阈值。

      示例： 90

    • operatorString

      比较运算符。

      示例： >

    • severityString

      告警级别。

      示例： critical

    • stateString

      当前状态。

      示例： firing

    • messageString

      错误返回消息。

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

    • fingerprintString

      指纹标识。

      示例： fp-abc123def456

    • sourceString

      来源信息。

      示例： prometheus

    • notifiedAtString

      已通知时间。

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

    • resolvedAtString

      已恢复时间。

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

    • acknowledgedByString

      用户由已确认告警。

      示例： admin

    • acknowledgedAtString

      已确认时间。

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

    • createDateString

      创建时间。

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

  • totalInteger

    返回结果总数。

    示例： 42

  • limitInteger

    最大返回条目数。

    示例： 20

  • offsetInteger

    查询起始偏移量。

    示例： 20

请求地址

GET/api/v1/alerting/alerts

/api/v1/alerting/alerts

操作 ID

ListAlerts

永久链接

请求示例

curl -X GET '{host}/api/v1/alerting/alerts' -H 'Authorization: Bearer {token}'

响应示例

200
{
  "items": [
    {}
  ],
  "total": 42,
  "limit": 20,
  "offset": 20
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史