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

试运行告警规则更新

干运行更新预览变更持久化。

POST/api/v1/alerting/rules/{ruleId}/dry-run

操作 ID

DryRunAlertRuleUpdate

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

路径参数

  • ruleId
    String必填

    规则ID。

请求体字段

  • input
    Object必填

    输入。

    • name
      String

      资源名称。

      示例： High CPU Usage

    • promql
      String

      生成的 PromQL 查询语句。

      示例： avg(cpu_usage_percent) > 90

    • threshold
      Long

      阈值。

      示例： 90

    • for
      String

      时长字符串子句。

      示例： 5m

响应状态

200 OK
200 OK

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

  • wouldSucceed
    Boolean

    更新成功应用。

    示例： true

  • changedFields
    List

    变更字段。

    示例： (nested array)

    • field
      String

      字段名称。

      示例： threshold

    • oldValue
      String

      先前值。

      示例： 90

    • newValue
      String

      新值。

      示例： 85

  • validationErrors
    List

    阻止更新。

    示例： item1,item2

  • warnings
    List

    告警信息列表。

    示例： item1,item2