跳转到主要内容
API Explorer|API Explorer
告警与响应相关接口/告警规则
POSTAlerting起始版本 1.0同步需要认证

验证告警规则

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

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • ruleObject必填

    告警规则输入校验。

    • nameString

      资源名称。

      示例： High CPU Usage

    • promqlString

      生成的 PromQL 查询语句。

      示例： avg(cpu_usage_percent) > 90

    • thresholdLong

      阈值。

      示例： 90

    • forString

      时长字符串子句。

      示例： 5m

响应状态

200 OK

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

  • validBoolean

    是否有效。

    示例： true

  • promqlErrorsList

    PROM QL语法错误列表。

    示例： item1,item2

  • wouldFireNowBoolean

    规则当前触发。

    示例： false

  • currentValueLong

    当前指标值已评估。

    示例： 45.2

  • thresholdLong

    阈值。

    示例： 90

  • nameConflictBoolean

    名称冲突。

    示例： false

  • validationErrorsList

    通用校验错误超出PROM QL。

    示例： item1,item2

请求地址

POST/api/v1/alerting/rules/validate

/api/v1/alerting/rules/validate

操作 ID

ValidateAlertRule

永久链接

请求示例

curl -X POST '{host}/api/v1/alerting/rules/validate' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"rule":{"name":"High CPU Usage","promql":"avg(cpu_usage_percent) > 90","threshold":90.0,"for":"5m"}}'

响应示例

200
{
  "valid": true,
  "promqlErrors": [],
  "wouldFireNow": false,
  "currentValue": 45.2,
  "threshold": 90.0,
  "nameConflict": false,
  "validationErrors": []
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史