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

预览告警抑制规则修改

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

POST/api/v1/alerting/inhibition-rules/{ruleId}/preview-change

操作 ID

PreviewAlertInhibitionRuleChange

起始版本

1.2.8

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • ruleId
    String必填

    规则ID。

请求体字段

  • operation
    String

    操作。

    示例： update

  • candidate
    Object

    更新必需操作更新。

    • ruleId
      String

      规则ID。

      示例： inhib-001

    • name
      String

      资源名称。

      示例： Updated inhibition rule

    • description
      String

      资源的详细描述。

      示例： Updated description

    • enabled
      Boolean

      是否启用。

      示例： true

    • sourceMatchers
      List

      资源。

      示例： (nested array)

    • targetMatchers
      List

      资源。

      示例： (nested array)

    • equalLabelNames
      List

      资源。

      示例： item1,item2

    • reason
      String

      原因说明。

      示例： value

响应状态

200 OK
200 OK

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

  • willReleaseCount
    String

    发布数量。

    示例： 2

  • willRemainSuppressedCount
    String

    保持已抑制数量。

    示例： 1

  • unknownCount
    String

    未知数量。

    示例： 1

  • asOf
    String

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

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