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

试运行告警规则

模拟规则评估针对当前数据创建告警。

调试可用性

在线调试

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

请求参数

请求体字段

  • expressionString必填

    表达式。

    示例： avg(cpu_usage_percent) > 90

  • durationString必填

    持续时间。

    示例： 5m

  • labelsLinkedHashMap必填

    标签列表。

    示例： (nested object)

  • evalTimestampString必填

    评估时间戳。

    示例： 2026-01-15T08:00:00Z

  • simulateHoursInteger必填

    模拟时长，单位为小时。

    示例： 24

响应状态

200 OK

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

  • validBoolean

    是否有效。

    示例： true

  • parseErrorString

    消息表达式无效。

    示例： syntax error at line 5

  • errorPositionInteger

    字符位置解析错误。

    示例： 20

  • firingBoolean

    规则当前触发。

    示例： true

  • matchedSeriesInteger

    已匹配序列。

    示例： 3

  • sampleValuesList

    已匹配时间序列。

    示例： (nested array)

    • labelsLinkedHashMap

      标签列表。

      示例： (nested object)

    • valueLong

      字段值。

      示例： 95.3

    • timestampString

      时间戳。

      示例： 2026-01-15T08:00:00Z

  • simulationSummaryObject

    指定时间范围。

    • totalEvalPointsInteger

      评估点总数。

      示例： 288

    • firingCountInteger

      触发数量。

      示例： 12

    • firingPercentageLong

      触发百分比。

      示例： 4.2

    • firstFiringAtString

      首次触发时间。

      示例： 2026-01-15T08:00:00Z

    • lastFiringAtString

      最近一次触发时间。

      示例： 2026-01-15T08:00:00Z

  • evalDurationString

    时长评估。

    示例： 120ms

请求地址

POST/api/v1/alerting/dry-run

/api/v1/alerting/dry-run

操作 ID

DryRunAlertRule

永久链接

请求示例

curl -X POST '{host}/api/v1/alerting/dry-run' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"expression":"avg(cpu_usage_percent) > 90","duration":"5m","labels":"(nested object)","evalTimestamp":"2026-01-15T08:00:00Z","simulateHours":24,"tenantId":"tenant-001"}'

响应示例

200
{
  "valid": true,
  "parseError": "connection refused",
  "errorPosition": 20,
  "firing": true,
  "matchedSeries": 3,
  "sampleValues": [
    {}
  ],
  "simulationSummary": {},
  "evalDuration": "120ms"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史