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

查询告警静默规则列表

列表静默规则分页支持。

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

  • search
    String

    搜索关键字。

  • sortBy
    String

    排序字段。必须与排序方向字段配合使用。

  • sortDirection
    String

    字段排序方向,必须跟 `sortBy` 配合使用。

响应状态

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

    • 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)

      • key
        String

        键。

        示例: severity

      • operator
        String

        比较运算符。

        示例: eq

      • value
        String

        字段值。

        示例: critical

    • enabled
      Boolean

      是否启用。

      示例: true

    • timezone
      String

      时区。

      示例: value

    • reason
      String

      原因说明。

      示例: value

    • lastModifiedBy
      String

      资源。

      示例: value

    • lastOpDate
      String

      最近一次操作时间。

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

    • version
      String

      版本号。

      示例: 10

    • currentHitCount
      String

      当前被此静默规则匹配的不同活跃告警主体数量。

      示例: 3

    • matchersDisplay
      List

      匹配器显示。

      示例: (nested array)

      • key
        String

        匹配器中的原始告警标签键,例如 `rule_uuid` 或 `resource_type`;与本地化显示名称一并保留,原始键不变。

        示例: value

      • operator
        String

        比较运算符。

        示例: value

      • value
        String

        字段值。

        示例: value

      • displayName
        String

        显示名称。用于界面展示。

        示例: value

      • valueDisplayName
        String

        值显示名称。

        示例: value

  • total
    Integer

    返回结果总数。

    示例: 5

  • limit
    Integer

    最大返回条目数。

    示例: 20

  • offset
    Integer

    查询起始偏移量。

    示例: 20

  • actionabilityScope
    String

    用于当前命中数的、由服务端选择的可操作范围。

    示例: platform_admin

  • asOf
    String

    用于标识当前命中计数所用抑制快照的 `RFC3339` 时间戳。

    示例: 2026-08-11T09:00:00Z

  • 变更时间

    新增请求参数 Accept-Language, search, sortBy...新增响应字段 actionabilityScope, asOf, currentHitCount...已删除响应字段 matcherKey, matcherType, matcherValue...
    查看 API