创建告警规则 V2
curl --request POST \
--url 'https://api.flashcat.cloud/monit/rule/v2/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"folder_id": 100,
"name": "CPU High",
"ds_type": "prometheus",
"ds_list": [
"prometheus*"
],
"enabled": true,
"cron_pattern": "0 * * * * *",
"channel_ids": [
20001
],
"rule_configs": {
"queries": [
{
"name": "A",
"expr": "100 - avg(cpu_usage_idle)"
}
],
"check_threshold": {
"enabled": true,
"alerting_check_times": 3,
"alerting_window_size": 5,
"recovery_check_times": 2,
"critical": "$A > 90",
"warning": "$A > 80",
"recovery_mode": "condition_clear"
}
}
}
'import requests
url = "https://api.flashcat.cloud/monit/rule/v2/create?app_key="
payload = {
"folder_id": 100,
"name": "CPU High",
"ds_type": "prometheus",
"ds_list": ["prometheus*"],
"enabled": True,
"cron_pattern": "0 * * * * *",
"channel_ids": [20001],
"rule_configs": {
"queries": [
{
"name": "A",
"expr": "100 - avg(cpu_usage_idle)"
}
],
"check_threshold": {
"enabled": True,
"alerting_check_times": 3,
"alerting_window_size": 5,
"recovery_check_times": 2,
"critical": "$A > 90",
"warning": "$A > 80",
"recovery_mode": "condition_clear"
}
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
folder_id: 100,
name: 'CPU High',
ds_type: 'prometheus',
ds_list: ['prometheus*'],
enabled: true,
cron_pattern: '0 * * * * *',
channel_ids: [20001],
rule_configs: {
queries: [{name: 'A', expr: '100 - avg(cpu_usage_idle)'}],
check_threshold: {
enabled: true,
alerting_check_times: 3,
alerting_window_size: 5,
recovery_check_times: 2,
critical: '$A > 90',
warning: '$A > 80',
recovery_mode: 'condition_clear'
}
}
})
};
fetch('https://api.flashcat.cloud/monit/rule/v2/create?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/monit/rule/v2/create?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'folder_id' => 100,
'name' => 'CPU High',
'ds_type' => 'prometheus',
'ds_list' => [
'prometheus*'
],
'enabled' => true,
'cron_pattern' => '0 * * * * *',
'channel_ids' => [
20001
],
'rule_configs' => [
'queries' => [
[
'name' => 'A',
'expr' => '100 - avg(cpu_usage_idle)'
]
],
'check_threshold' => [
'enabled' => true,
'alerting_check_times' => 3,
'alerting_window_size' => 5,
'recovery_check_times' => 2,
'critical' => '$A > 90',
'warning' => '$A > 80',
'recovery_mode' => 'condition_clear'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/monit/rule/v2/create?app_key="
payload := strings.NewReader("{\n \"folder_id\": 100,\n \"name\": \"CPU High\",\n \"ds_type\": \"prometheus\",\n \"ds_list\": [\n \"prometheus*\"\n ],\n \"enabled\": true,\n \"cron_pattern\": \"0 * * * * *\",\n \"channel_ids\": [\n 20001\n ],\n \"rule_configs\": {\n \"queries\": [\n {\n \"name\": \"A\",\n \"expr\": \"100 - avg(cpu_usage_idle)\"\n }\n ],\n \"check_threshold\": {\n \"enabled\": true,\n \"alerting_check_times\": 3,\n \"alerting_window_size\": 5,\n \"recovery_check_times\": 2,\n \"critical\": \"$A > 90\",\n \"warning\": \"$A > 80\",\n \"recovery_mode\": \"condition_clear\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/monit/rule/v2/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"folder_id\": 100,\n \"name\": \"CPU High\",\n \"ds_type\": \"prometheus\",\n \"ds_list\": [\n \"prometheus*\"\n ],\n \"enabled\": true,\n \"cron_pattern\": \"0 * * * * *\",\n \"channel_ids\": [\n 20001\n ],\n \"rule_configs\": {\n \"queries\": [\n {\n \"name\": \"A\",\n \"expr\": \"100 - avg(cpu_usage_idle)\"\n }\n ],\n \"check_threshold\": {\n \"enabled\": true,\n \"alerting_check_times\": 3,\n \"alerting_window_size\": 5,\n \"recovery_check_times\": 2,\n \"critical\": \"$A > 90\",\n \"warning\": \"$A > 80\",\n \"recovery_mode\": \"condition_clear\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/rule/v2/create?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"folder_id\": 100,\n \"name\": \"CPU High\",\n \"ds_type\": \"prometheus\",\n \"ds_list\": [\n \"prometheus*\"\n ],\n \"enabled\": true,\n \"cron_pattern\": \"0 * * * * *\",\n \"channel_ids\": [\n 20001\n ],\n \"rule_configs\": {\n \"queries\": [\n {\n \"name\": \"A\",\n \"expr\": \"100 - avg(cpu_usage_idle)\"\n }\n ],\n \"check_threshold\": {\n \"enabled\": true,\n \"alerting_check_times\": 3,\n \"alerting_window_size\": 5,\n \"recovery_check_times\": 2,\n \"critical\": \"$A > 90\",\n \"warning\": \"$A > 80\",\n \"recovery_mode\": \"condition_clear\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"id": 50001,
"account_id": 888,
"folder_id": 100,
"name": "CPU High",
"labels": {},
"ds_type": "prometheus",
"ds_list": [
"prometheus*"
],
"ds_ids": [],
"enabled": true,
"debug_log_enabled": false,
"rule_configs": {
"queries": [
{
"name": "A",
"expr": "100 - avg(cpu_usage_idle)"
}
],
"check_threshold": {
"enabled": true,
"alerting_check_times": 3,
"alerting_window_size": 5,
"recovery_check_times": 2,
"critical": "$A > 90",
"warning": "$A > 80",
"recovery_mode": "condition_clear"
}
},
"cron_pattern": "0 * * * * *",
"timezone": "Asia/Shanghai",
"delay_seconds": 0,
"enabled_times": [
{
"days": [
1,
2,
3,
4,
5,
6,
0
],
"stime": "00:00",
"etime": "23:59"
}
],
"annotations": {},
"description_type": "text",
"description": "",
"channel_ids": [
20001
],
"repeat_interval": 3600,
"repeat_total": 3,
"investigation_targets": [],
"creator_id": 66,
"creator_name": "zhangsan",
"updater_id": 66,
"updater_name": "zhangsan",
"created_at": 1712000000,
"updated_at": 1712000000
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}告警规则
创建告警规则 V2
创建新的 V2 告警规则，返回带有分配 ID 的已创建规则。
POST
/
monit
/
rule
/
v2
/
create
创建告警规则 V2
curl --request POST \
--url 'https://api.flashcat.cloud/monit/rule/v2/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"folder_id": 100,
"name": "CPU High",
"ds_type": "prometheus",
"ds_list": [
"prometheus*"
],
"enabled": true,
"cron_pattern": "0 * * * * *",
"channel_ids": [
20001
],
"rule_configs": {
"queries": [
{
"name": "A",
"expr": "100 - avg(cpu_usage_idle)"
}
],
"check_threshold": {
"enabled": true,
"alerting_check_times": 3,
"alerting_window_size": 5,
"recovery_check_times": 2,
"critical": "$A > 90",
"warning": "$A > 80",
"recovery_mode": "condition_clear"
}
}
}
'import requests
url = "https://api.flashcat.cloud/monit/rule/v2/create?app_key="
payload = {
"folder_id": 100,
"name": "CPU High",
"ds_type": "prometheus",
"ds_list": ["prometheus*"],
"enabled": True,
"cron_pattern": "0 * * * * *",
"channel_ids": [20001],
"rule_configs": {
"queries": [
{
"name": "A",
"expr": "100 - avg(cpu_usage_idle)"
}
],
"check_threshold": {
"enabled": True,
"alerting_check_times": 3,
"alerting_window_size": 5,
"recovery_check_times": 2,
"critical": "$A > 90",
"warning": "$A > 80",
"recovery_mode": "condition_clear"
}
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
folder_id: 100,
name: 'CPU High',
ds_type: 'prometheus',
ds_list: ['prometheus*'],
enabled: true,
cron_pattern: '0 * * * * *',
channel_ids: [20001],
rule_configs: {
queries: [{name: 'A', expr: '100 - avg(cpu_usage_idle)'}],
check_threshold: {
enabled: true,
alerting_check_times: 3,
alerting_window_size: 5,
recovery_check_times: 2,
critical: '$A > 90',
warning: '$A > 80',
recovery_mode: 'condition_clear'
}
}
})
};
fetch('https://api.flashcat.cloud/monit/rule/v2/create?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/monit/rule/v2/create?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'folder_id' => 100,
'name' => 'CPU High',
'ds_type' => 'prometheus',
'ds_list' => [
'prometheus*'
],
'enabled' => true,
'cron_pattern' => '0 * * * * *',
'channel_ids' => [
20001
],
'rule_configs' => [
'queries' => [
[
'name' => 'A',
'expr' => '100 - avg(cpu_usage_idle)'
]
],
'check_threshold' => [
'enabled' => true,
'alerting_check_times' => 3,
'alerting_window_size' => 5,
'recovery_check_times' => 2,
'critical' => '$A > 90',
'warning' => '$A > 80',
'recovery_mode' => 'condition_clear'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/monit/rule/v2/create?app_key="
payload := strings.NewReader("{\n \"folder_id\": 100,\n \"name\": \"CPU High\",\n \"ds_type\": \"prometheus\",\n \"ds_list\": [\n \"prometheus*\"\n ],\n \"enabled\": true,\n \"cron_pattern\": \"0 * * * * *\",\n \"channel_ids\": [\n 20001\n ],\n \"rule_configs\": {\n \"queries\": [\n {\n \"name\": \"A\",\n \"expr\": \"100 - avg(cpu_usage_idle)\"\n }\n ],\n \"check_threshold\": {\n \"enabled\": true,\n \"alerting_check_times\": 3,\n \"alerting_window_size\": 5,\n \"recovery_check_times\": 2,\n \"critical\": \"$A > 90\",\n \"warning\": \"$A > 80\",\n \"recovery_mode\": \"condition_clear\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/monit/rule/v2/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"folder_id\": 100,\n \"name\": \"CPU High\",\n \"ds_type\": \"prometheus\",\n \"ds_list\": [\n \"prometheus*\"\n ],\n \"enabled\": true,\n \"cron_pattern\": \"0 * * * * *\",\n \"channel_ids\": [\n 20001\n ],\n \"rule_configs\": {\n \"queries\": [\n {\n \"name\": \"A\",\n \"expr\": \"100 - avg(cpu_usage_idle)\"\n }\n ],\n \"check_threshold\": {\n \"enabled\": true,\n \"alerting_check_times\": 3,\n \"alerting_window_size\": 5,\n \"recovery_check_times\": 2,\n \"critical\": \"$A > 90\",\n \"warning\": \"$A > 80\",\n \"recovery_mode\": \"condition_clear\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/rule/v2/create?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"folder_id\": 100,\n \"name\": \"CPU High\",\n \"ds_type\": \"prometheus\",\n \"ds_list\": [\n \"prometheus*\"\n ],\n \"enabled\": true,\n \"cron_pattern\": \"0 * * * * *\",\n \"channel_ids\": [\n 20001\n ],\n \"rule_configs\": {\n \"queries\": [\n {\n \"name\": \"A\",\n \"expr\": \"100 - avg(cpu_usage_idle)\"\n }\n ],\n \"check_threshold\": {\n \"enabled\": true,\n \"alerting_check_times\": 3,\n \"alerting_window_size\": 5,\n \"recovery_check_times\": 2,\n \"critical\": \"$A > 90\",\n \"warning\": \"$A > 80\",\n \"recovery_mode\": \"condition_clear\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"id": 50001,
"account_id": 888,
"folder_id": 100,
"name": "CPU High",
"labels": {},
"ds_type": "prometheus",
"ds_list": [
"prometheus*"
],
"ds_ids": [],
"enabled": true,
"debug_log_enabled": false,
"rule_configs": {
"queries": [
{
"name": "A",
"expr": "100 - avg(cpu_usage_idle)"
}
],
"check_threshold": {
"enabled": true,
"alerting_check_times": 3,
"alerting_window_size": 5,
"recovery_check_times": 2,
"critical": "$A > 90",
"warning": "$A > 80",
"recovery_mode": "condition_clear"
}
},
"cron_pattern": "0 * * * * *",
"timezone": "Asia/Shanghai",
"delay_seconds": 0,
"enabled_times": [
{
"days": [
1,
2,
3,
4,
5,
6,
0
],
"stime": "00:00",
"etime": "23:59"
}
],
"annotations": {},
"description_type": "text",
"description": "",
"channel_ids": [
20001
],
"repeat_interval": 3600,
"repeat_total": 3,
"investigation_targets": [],
"creator_id": 66,
"creator_name": "zhangsan",
"updater_id": 66,
"updater_name": "zhangsan",
"created_at": 1712000000,
"updated_at": 1712000000
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}限制说明
| 项目 | 说明 |
|---|---|
| 速率限制 | 每个账户 300 次/分钟；20 次/秒 |
| 权限要求 | 告警规则管理（monit） |
使用说明
name、ds_type、enabled、cron_pattern和rule_configs.queries为必填项；ds_list（支持通配符）或ds_ids必须有一个非空。enabled必须显式传入（包括false），缺失时返回InvalidParameter。id、account_id、creator_*、updater_*、created_at、updated_at由服务端赋值，客户端传入将被忽略。name在folder_id内必须唯一；重名会返回InvalidParameter。channel_ids可为空，告警将通过全局集成路由。- 请求体容忍额外的未知字段（向前兼容），未知字段会被忽略。
- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。
授权
在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。
请求体
application/json
完整的 V2 告警规则配置。与 V1 的核心差异在 rule_configs：三个检查器使用 lifecycle v2 的 recovery_mode/end_mode 枚举描述恢复与结束语义。
规则所属文件夹 ID，可通过 POST /monit/folder/list 获取。创建后不可通过更新接口修改，调整文件夹请使用 /monit/rule/move。
规则名称，同一文件夹内必须唯一，最长 128 个字符。
数据源类型标识（如 prometheus、elasticsearch）。
是否启用规则。必填，服务端解码时强制要求显式传入（包括 false）。更新为 false 时服务端会清理该规则的活跃告警。
检测配置，包含查询列表与触发/恢复条件，结构见 AlertRuleConfigsV2。
Show child attributes
Show child attributes
调度表达式：6 段（含秒）cron 表达式或 @every 30s 间隔描述。不允许以 CRON_TZ= 或 TZ= 开头，时区请填写到 timezone 字段。
规则 ID。更新时必填，创建时省略（服务端自动分配）。
账户 ID，由服务端按认证信息自动填充，客户端传入将被忽略。
自定义标签。
Show child attributes
Show child attributes
数据源名称匹配模式（支持通配符）。ds_list / ds_ids 至少一个非空，两者合并共同决定规则监控哪些数据源。
数据源 ID 列表，与 ds_list 合并后共同决定规则监控的数据源，使用 ID 可避免数据源改名后失效。ds_list 与 ds_ids 至少提供一个。
是否开启调试日志，开启后 edge 评估该规则时输出详细日志，用于排查规则未按预期触发等问题。
告警规则执行时区，决定 cron 调度与生效时间窗口的解释方式。仅接受 IANA 时区名（如 Asia/Shanghai、UTC、Europe/London）；不接受 Local、UTC+8、CST 等简写或偏移量。留空时按 Asia/Shanghai 处理。
评估时查询窗口向前偏移的秒数，用于补偿数据摄入延迟。
规则生效的时间窗口。省略或传空数组时，默认每天 00:00–23:59 生效。
Show child attributes
Show child attributes
附加注解键值对，随告警事件下发；键不允许以 $ 开头（该前缀保留给查询字段）。
Show child attributes
Show child attributes
描述内容的格式。省略或为空时默认使用 text。text = 纯文本；markdown = Markdown 格式，告警详情中按 Markdown 渲染。
可用选项:
text, markdown 规则描述，Markdown 格式。
告警发送到的协作空间 ID 列表。可为空，告警将通过全局集成路由。
通知重复间隔（秒）。小于 1 时按默认值 3600 处理。
最大重复通知次数。小于 1 时按默认值 3 处理。
告警事件详情页关联的排障入口列表，最多 20 项，不允许重复。更新接口中该字段按 presence 处理：省略时保留原配置，传 [] 清空。
Show child attributes
Show child attributes
创建人 ID，由服务端按当前用户自动填充，客户端传入将被忽略。
创建人名称，由服务端自动填充，客户端传入将被忽略。
最近更新人 ID，由服务端自动填充，客户端传入将被忽略。
最近更新人名称，由服务端自动填充，客户端传入将被忽略。
创建时间，Unix 秒级时间戳，由服务端生成，客户端传入将被忽略。
最近更新时间，Unix 秒级时间戳，由服务端生成，客户端传入将被忽略。
响应
成功
成功响应结构。2xx 响应中 request_id 标识本次调用（同时出现在 Flashcat-Request-Id 响应头中），data 为接口业务 payload。失败响应使用不同结构，参见 ErrorResponse。
此页面对您有帮助吗？