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

查询告警静默规则列表

列表静默规则分页支持。

GET/api/v1/alerting/silence-rules

操作 ID

ListAlertSilenceRules

起始版本

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，唯一标识该资源。

      示例： silence-001

    • name
      String

      资源名称。

      示例： Maintenance Window Q1

    • description
      String

      资源的详细描述。

      示例： Suppress alerts during scheduled maintenance

    • matcherType
      String

      匹配器类型。

      示例： value

    • matcherKey
      String

      标签键匹配针对。

      示例： value

    • matcherValue
      String

      标签值模式匹配。

      示例： value

    • startsAt
      String

      开始时间。

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

    • endsAt
      String

      结束时间。

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

    • createdBy
      String

      创建该记录的用户UUID。

      示例： admin

    • createDate
      String

      创建时间。

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

    • matchers
      List

      匹配器。

      示例： (nested array)

      • type
        String

        类型。

        示例： exact

      • key
        String

        键。

        示例： severity

      • value
        String

        字段值。

        示例： critical

  • total
    Integer

    返回结果总数。

    示例： 5

  • limit
    Integer

    最大返回条目数。

    示例： 20

  • offset
    Integer

    查询起始偏移量。

    示例： 20