跳转到主要内容
POST
/
monit
/
rule
/
create
创建告警规则
curl --request POST \
  --url 'https://api.flashcat.cloud/monit/rule/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "folder_id": 100,
  "name": "CPU 过高",
  "ds_type": "prometheus",
  "ds_list": [
    "prometheus*"
  ],
  "enabled": true,
  "cron_pattern": "* * * * *",
  "channel_ids": [
    20001
  ],
  "rule_configs": {
    "queries": [
      {
        "name": "A",
        "expr": "avg(cpu_usage_idle) < 10"
      }
    ],
    "check_threshold": {
      "enabled": true,
      "critical": "A",
      "alerting_check_times": 1,
      "recovery_check_times": 1,
      "push_recovery_event": true,
      "recovery": {
        "mode": "invert"
      }
    }
  }
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "id": 50001,
    "folder_id": 100,
    "name": "CPU 过高",
    "ds_type": "prometheus",
    "created_at": 1712000000
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求告警规则管理monit

使用说明

  • nameds_typecron_patternrule_configs.queries 为必填项。
  • ds_list(支持通配符)或 ds_ids 必须有一个非空。
  • cron_pattern 使用标准 5 字段 cron 语法。
  • channel_ids 可为空,告警将通过全局集成路由。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

application/json

完整的告警规则配置。

id
integer<uint64>
account_id
integer<uint64>
folder_id
integer<uint64>

规则所属文件夹。

name
string

规则名称。

labels
object

自定义标签。

ds_type
string

数据源类型。

ds_list
string[]

数据源名称模式(支持通配符)。

ds_ids
integer<uint64>[]

具体数据源 ID 列表。

enabled
boolean
debug_log_enabled
boolean
rule_configs
object

规则评估配置。

cron_pattern
string

5 字段 cron 调度。

delay_seconds
integer
enabled_times
object[]

规则生效的时间窗口。

annotations
object
description_type
enum<string>
可用选项:
text,
markdown
description
string
channel_ids
integer<uint64>[]

告警发送到的协作空间 ID 列表。

repeat_interval
integer<int64>

通知重复间隔(秒)。

repeat_total
integer<int64>

最大重复通知次数。

creator_id
integer<uint64>
creator_name
string
updater_id
integer<uint64>
updater_name
string
created_at
integer<int64>
updated_at
integer<int64>

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

完整的告警规则配置。