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

验证告警规则

校验告警规则定义正确性保存。

POST/api/v1/alerting/rules/validate

操作 ID

ValidateAlertRule

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • rule
    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 成功时返回以下响应结构。

  • valid
    Boolean

    是否有效。

    示例： true

  • promqlErrors
    List

    PROM QL语法错误列表。

    示例： item1,item2

  • wouldFireNow
    Boolean

    规则当前触发。

    示例： false

  • currentValue
    Long

    当前指标值已评估。

    示例： 45.2

  • threshold
    Long

    阈值。

    示例： 90

  • nameConflict
    Boolean

    名称冲突。

    示例： false

  • validationErrors
    List

    通用校验错误超出PROM QL。

    示例： item1,item2