接口参考监控、告警与通知
更新告警规则
PUT /api/v1/monitoring/rules/{id},updateMonitoringRule 的请求参数和响应结构。
PUT /api/v1/monitoring/rules/{id}
| 项目 | 内容 |
|---|---|
| 操作标识 | updateMonitoringRule |
| 认证 | 登录会话 Cookie |
会话写请求需要合法的 Origin 和与当前 Cookie 绑定的 X-CSRF-Token。登录成功后应重新获取 CSRF 令牌。具体权限由目标资源归属和当前授权决定,见认证约定。
请求参数
| 名称 | 位置 | 必填 | 类型 | 说明与约束 |
|---|---|---|---|---|
| id | path | 是 | string | 格式:uuid |
请求体
请求体必填。
内容类型:application/json。
| 字段 | 类型 | 必填 | 说明与约束 |
|---|---|---|---|
| tenant_id | string | 是 | — |
| name | string | 是 | — |
| target_type | string | 是 | 可选值:"host"、"instance" |
| metric | string | 是 | 可选值:"cpu_usage"、"memory_usage"、"storage_usage"、"offline" |
| operator | string | 是 | 可选值:"gt"、"gte"、"lt"、"lte"、"eq" |
| threshold | number | 是 | — |
| hold_seconds | integer | 是 | — |
| interval_seconds | integer | 是 | 可选值:60、300 |
| severity | string | 是 | 可选值:"info"、"warning"、"critical" |
| enabled | boolean | 是 | — |
| description | string | 是 | — |
| target_ids | string[] | 是 | — |
| channel_ids | string[] | 是 | — |
完整请求结构(含引用定义)
{
"$ref": "#/$defs/MonitoringRuleInput",
"$defs": {
"MonitoringRuleInput": {
"type": "object",
"additionalProperties": false,
"properties": {
"tenant_id": {
"type": "string"
},
"name": {
"type": "string"
},
"target_type": {
"type": "string",
"enum": [
"host",
"instance"
]
},
"metric": {
"type": "string",
"enum": [
"cpu_usage",
"memory_usage",
"storage_usage",
"offline"
]
},
"operator": {
"type": "string",
"enum": [
"gt",
"gte",
"lt",
"lte",
"eq"
]
},
"threshold": {
"type": "number"
},
"hold_seconds": {
"type": "integer"
},
"interval_seconds": {
"type": "integer",
"enum": [
60,
300
]
},
"severity": {
"type": "string",
"enum": [
"info",
"warning",
"critical"
]
},
"enabled": {
"type": "boolean"
},
"description": {
"type": "string"
},
"target_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"channel_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"required": [
"tenant_id",
"name",
"target_type",
"metric",
"operator",
"threshold",
"hold_seconds",
"interval_seconds",
"severity",
"enabled",
"description",
"target_ids",
"channel_ids"
]
}
}
}响应
| HTTP 状态 | 含义 |
|---|---|
| 200 | 成功 |
| 400 | 参数错误 |
| 401 | 登录无效或已撤销 |
| 403 | 权限、范围或 CSRF 校验失败 |
| 404 | 记录不存在 |
| 409 | 引用或唯一性冲突 |
| 429 | 请求过于频繁 |
| 503 | 数据库未配置或不可用 |
200 · application/json 响应结构
| 字段 | 类型 | 必填 | 说明与约束 |
|---|---|---|---|
| data | MonitoringRule | 是 | — |
| request_id | string | 是 | — |
{
"$ref": "#/$defs/MonitoringRuleResponse",
"$defs": {
"MonitoringRuleResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/$defs/MonitoringRule"
},
"request_id": {
"type": "string"
}
},
"required": [
"data",
"request_id"
]
},
"MonitoringRule": {
"type": "object",
"additionalProperties": false,
"properties": {
"tenant_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string"
},
"target_type": {
"type": "string",
"enum": [
"host",
"instance"
]
},
"metric": {
"type": "string",
"enum": [
"cpu_usage",
"memory_usage",
"storage_usage",
"offline"
]
},
"operator": {
"type": "string",
"enum": [
"gt",
"gte",
"lt",
"lte",
"eq"
]
},
"threshold": {
"type": "number"
},
"hold_seconds": {
"type": "integer"
},
"interval_seconds": {
"type": "integer",
"enum": [
60,
300
]
},
"severity": {
"type": "string",
"enum": [
"info",
"warning",
"critical"
]
},
"enabled": {
"type": "boolean"
},
"description": {
"type": "string"
},
"target_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"channel_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"id": {
"type": "string",
"format": "uuid"
},
"next_evaluation": {
"type": "string",
"format": "date-time"
},
"evaluated_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"evaluation_state": {
"type": "string"
},
"error": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"required": [
"tenant_id",
"name",
"target_type",
"metric",
"operator",
"threshold",
"hold_seconds",
"interval_seconds",
"severity",
"enabled",
"description",
"target_ids",
"channel_ids",
"id",
"next_evaluation",
"evaluated_at",
"evaluation_state",
"error",
"created_at",
"updated_at",
"deleted_at"
]
}
}
}400 / 401 / 403 / 404 / 409 / 429 / 503 · application/json 响应结构
{
"$ref": "#/$defs/ErrorResponse",
"$defs": {
"ErrorResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"error": {
"$ref": "#/$defs/ErrorDetail"
},
"request_id": {
"type": "string"
}
},
"required": [
"error",
"request_id"
]
},
"ErrorDetail": {
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"enum": [
"NOT_IMPLEMENTED",
"NOT_FOUND",
"AUTH_REQUIRED",
"FORBIDDEN",
"VALIDATION_FAILED",
"CONFLICT",
"SERVICE_UNAVAILABLE",
"INTERNAL_ERROR",
"RATE_LIMITED"
]
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"code",
"message",
"retryable"
]
}
}
}响应中的 request_id 用于排查请求;异步操作以任务最终状态为准。参阅调用约定、异步任务和错误处理。
本页由版本化 OpenAPI 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。
