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

预览告警静默规则修改

预览更新、禁用或删除静默规则对当前抑制效果的影响,不修改状态。

POST/api/v1/alerting/silence-rules/{ruleUuid}/preview-change

操作 ID

PreviewAlertSilenceRuleChange

起始版本

1.2.8

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • ruleUuid
    String必填

    规则UUID。

请求体字段

  • operation
    String

    操作。

    示例: update

  • candidate
    Object

    更新必需操作更新。

    • ruleUuid
      String

      规则UUID。

      示例: value

    • name
      String

      资源名称。

      示例: Maintenance Window Q1

    • description
      String

      资源的详细描述。

      示例: A brief description

    • matchers
      List

      资源。

      示例: (nested array)

      • key
        String

        键。

        示例: severity

      • operator
        String

        比较运算符。

        示例: eq

      • value
        String

        字段值。

        示例: critical

    • startsAt
      String

      开始时间。

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

    • endsAt
      String

      结束时间。

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

    • enabled
      Boolean

      是否启用。

      示例: true

    • timezone
      String

      时区。

      示例: value

    • reason
      String

      原因说明。

      示例: value

    • lastModifiedBy
      String

      资源。

      示例: value

响应状态

200 OK
200 OK

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

  • willReleaseCount
    String

    发布数量。

    示例: 2

  • willRemainSuppressedCount
    String

    保持已抑制数量。

    示例: 1

  • unknownCount
    String

    未知数量。

    示例: 1

  • asOf
    String

    用于标识预览所用不可变抑制快照的 `RFC3339` 时间戳。

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