跳转到主要内容
告警与响应相关接口/告警路由与策略

更新告警通知策略

更新已存在通知路由策略。

PUT/api/v1/alerting/notification-policies/{uuid}

操作 ID

UpdateAlertNotificationPolicy

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • uuid
    String必填

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

请求体字段

  • name
    String

    资源名称。

    示例: Updated Routing Policy

  • description
    String

    资源的详细描述。

    示例: Updated routing description

  • priority
    Integer

    优先级。

    示例: 2

  • matchers
    List

    已更新标签匹配器。

    示例: (nested array)

    • key
      String

      键。

      示例: severity

    • operator
      String

      比较运算符。

      示例: eq

    • value
      String

      字段值。

      示例: critical

  • channelIds
    List

    已更新渠道UUI DS。

    示例: item1,item2

响应状态

200 OK
200 OK

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

  • uuid
    String

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

    示例: policy-001

  • name
    String

    资源名称。

    示例: Critical Alert Routing

  • description
    String

    资源的详细描述。

    示例: Route critical alerts to ops channels

  • priority
    Integer

    优先级。

    示例: 1

  • isDefault
    Boolean

    是否默认捕获策略。

    示例: false

  • matchers
    List

    标签匹配器路由决策。

    示例: (nested array)

    • key
      String

      键。

      示例: severity

    • operator
      String

      比较运算符。

      示例: eq

    • value
      String

      字段值。

      示例: critical

  • channelIds
    List

    渠道UUI DS投递通知。

    示例: item1,item2

  • groupBy
    List

    分组字段。

    示例: item1,item2

  • groupWait
    Integer

    秒等待发送首次通知。

    示例: 30

  • groupInterval
    Integer

    组周期。

    示例: 300

  • repeatInterval
    Integer

    重复周期。

    示例: 3600

  • status
    String

    状态信息。

    示例: active

  • createDate
    String

    创建时间。

    示例: 2024-01-15T09:00:00Z

  • lastOpDate
    String

    最近一次操作时间。

    示例: 2024-01-15T09:00:00Z

  • matchersDisplay
    List

    匹配器显示。

    示例: (nested array)

    • key
      String

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

      示例: value

    • operator
      String

      比较运算符。

      示例: value

    • value
      String

      字段值。

      示例: value

    • displayName
      String

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

      示例: value

    • valueDisplayName
      String

      值显示名称。

      示例: value

  • sendResolved
    Boolean

    是否将该策略的恢复通知加入队列。默认为 `true`;值为 `false` 时会显式返回。不影响已排队的通知投递和重试。内置控制台策略始终同步恢复状态。

    示例: false

  • 变更时间

    新增请求体字段 sendResolved新增响应字段 sendResolved
    查看 API
  • 变更时间

    新增响应字段 displayName, matchersDisplay, valueDisplayName
    查看 API