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

创建告警规则

创建新告警规则阈值通知设置。

调试可用性

在线调试

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

请求参数

请求体字段

  • nameString必填

    资源名称。

    示例： High CPU Usage

  • descriptionString必填

    资源的详细描述。

    示例： Alert when CPU exceeds 90%

  • resourceTypeString必填

    资源类型。

    示例： vm

  • metricNameString必填

    监控项名称。

    示例： cpu_usage_percent

  • operatorString必填

    比较运算符。

    示例： >

响应状态

200 OK

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

  • uuidString

    资源的UUID，唯一标识该资源。

    示例： rule-abc123-def456

  • nameString

    资源名称。

    示例： High CPU Usage

  • descriptionString

    资源的详细描述。

    示例： Triggers when CPU usage exceeds 90% for 5 minutes

  • resourceTypeString

    资源类型。

    示例： vm

  • metricNameString

    监控项名称。

    示例： cpu_usage_percent

  • operatorString

    比较运算符。

    示例： >

  • thresholdLong

    阈值。

    示例： 90

  • durationInteger

    持续时间。

    示例： 300

  • severityString

    告警级别。

    示例： critical

  • stateString

    当前状态。

    示例： enabled

  • notifyUrlString

    通知回调地址。

    示例： https://example.com/callback

  • platformUuidString

    平台UUID。

    示例： plat-001-abc

  • typeString

    类型。

    示例： metric

  • logQueryString

    日志查询语句。

    示例： level=error AND service=payment

  • logWindowInteger

    日志查询时间窗口。

    示例： 600

  • categoryString

    类型分类。

    示例： infrastructure

  • labelSelectorsLinkedHashMap

    标签选择器。

    示例： (nested object)

  • sourceString

    来源信息。

    示例： builtin

  • impactScopeString

    影响范围。

    示例： cluster

  • createDateString

    创建时间。

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

  • lastOpDateString

    最近一次操作时间。

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

  • adapterTypeString

    监控后端。

    示例： prometheus

  • userModifiedBoolean

    用户已修改。

    示例： false

  • deprecatedBoolean

    已弃用。

    示例： false

  • createdByString

    创建该记录的用户UUID。

    示例： admin

  • lastModifiedByString

    最后修改人。

    示例： admin

  • actionsList

    附加规则修复02 RI AA V 02。

    示例： (nested array)

    • uuidString

      资源的UUID，唯一标识该资源。

      示例： action-001

    • ruleUuidString

      规则UUID。

      示例： rule-abc123-def456

    • typeString

      类型。

      示例： command_snippet

    • labelString

      显示标签动作按钮。

      示例： Restart Service

    • contentString

      动作内容命令地址建议文本。

      示例： systemctl restart nginx

    • orderIndexInteger

      显示顺序索引多个动作。

      示例： 1

    • createDateString

      创建时间。

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

请求地址

POST/api/v1/alerting/rules

/api/v1/alerting/rules

操作 ID

CreateAlertRule

永久链接

请求示例

curl -X POST '{host}/api/v1/alerting/rules' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"High CPU Usage","description":"Alert when CPU exceeds 90%","resourceType":"vm","metricName":"cpu_usage_percent","operator":">","threshold":90.0,"duration":300,"severity":"critical","state":"enabled","notifyUrl":"https://example.com/callback","platformUuid":"plat-001-abc","type":"metric","logQuery":"level=error","logWindow":600,"actions":"(nested array)","labelSelectors":"(nested object)"}'

响应示例

200
{
  "uuid": "rule-abc123-def456",
  "name": "High CPU Usage",
  "description": "Triggers when CPU usage exceeds 90% for 5 minutes",
  "resourceType": "vm",
  "metricName": "cpu_usage_percent",
  "operator": ">",
  "threshold": 90.0,
  "duration": 300
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史