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

试运行告警规则更新

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

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • ruleIdString必填

    规则ID。

请求体字段

  • inputObject必填

    输入。

    • nameString

      资源名称。

      示例： High CPU Usage

    • promqlString

      生成的 PromQL 查询语句。

      示例： avg(cpu_usage_percent) > 90

    • thresholdLong

      阈值。

      示例： 90

    • forString

      时长字符串子句。

      示例： 5m

响应状态

200 OK

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

  • wouldSucceedBoolean

    更新成功应用。

    示例： true

  • changedFieldsList

    变更字段。

    示例： (nested array)

    • fieldString

      字段名称。

      示例： threshold

    • oldValueString

      先前值。

      示例： 90

    • newValueString

      新值。

      示例： 85

  • validationErrorsList

    阻止更新。

    示例： item1,item2

  • warningsList

    告警信息列表。

    示例： item1,item2

请求地址

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

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

操作 ID

DryRunAlertRuleUpdate

永久链接

请求示例

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

响应示例

200
{
  "wouldSucceed": true,
  "changedFields": [
    {}
  ],
  "validationErrors": [],
  "warnings": []
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史