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

更新告警抑制规则

更新已存在抑制规则配置。

PUT/api/v1/alerting/inhibition-rules/{ruleId}

操作 ID

UpdateAlertInhibitionRule

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • ruleId
    String必填

    规则ID。

请求体字段

  • name
    String

    资源名称。

    示例: Updated inhibition rule

  • description
    String

    资源的详细描述。

    示例: Updated description

  • enabled
    Boolean

    是否启用。

    示例: true

  • sourceMatchers
    List

    资源。

    示例: (nested array)

  • targetMatchers
    List

    资源。

    示例: (nested array)

响应状态

200 OK
200 OK

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

  • uuid
    String

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

    示例: inhib-001

  • name
    String

    资源名称。

    示例: Suppress disk alerts when host down

  • description
    String

    资源的详细描述。

    示例: Suppress disk alerts when host is unreachable

  • enabled
    Boolean

    是否启用。

    示例: true

  • createDate
    String

    创建时间。

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

  • lastOpDate
    String

    最近一次操作时间。

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

  • sourceMatchers
    List

    资源。

    示例: (nested array)

    • key
      String

      键。

      示例: severity

    • operator
      String

      比较运算符。

      示例: eq

    • value
      String

      字段值。

      示例: critical

  • targetMatchers
    List

    资源。

    示例: (nested array)

    • key
      String

      键。

      示例: severity

    • operator
      String

      比较运算符。

      示例: eq

    • value
      String

      字段值。

      示例: critical

  • equalLabelNames
    List

    资源。

    示例: item1,item2

  • reason
    String

    原因说明。

    示例: value

  • createdBy
    String

    创建该记录的用户UUID。

    示例: value

  • lastModifiedBy
    String

    资源。

    示例: value

  • version
    String

    版本号。

    示例: 10

  • currentHitCount
    String

    当前被此抑制规则匹配的不同活跃目标告警主体数量。

    示例: 3

  • sourceMatchersDisplay
    List

    源匹配器显示。

    示例: (nested array)

    • key
      String

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

      示例: value

    • operator
      String

      比较运算符。

      示例: value

    • value
      String

      字段值。

      示例: value

    • displayName
      String

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

      示例: value

    • valueDisplayName
      String

      值显示名称。

      示例: value

  • targetMatchersDisplay
    List

    目标匹配器显示。

    示例: (nested array)

    • key
      String

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

      示例: value

    • operator
      String

      比较运算符。

      示例: value

    • value
      String

      字段值。

      示例: value

    • displayName
      String

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

      示例: value

    • valueDisplayName
      String

      值显示名称。

      示例: value

  • 变更时间

    新增请求体字段 equalLabelNames, reason, sourceMatchers...已删除请求体字段 equalLabels, sourceMatch, targetMatch新增响应字段 createdBy, currentHitCount, displayName...已删除响应字段 equalLabels, sourceMatch, targetMatch
    查看 API