创建规则集

在规则仓库中创建新的规则集。

POST /monit/store/ruleset/create

创建规则集

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/monit/store/ruleset/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type_ident": "prometheus",
  "note": "CPU 用量告警",
  "open_flag": 1,
  "payload": "[{\"prom_ql\":\"rate(cpu_usage[5m]) > 0.8\"}]"
}
'

import requests

url = "https://api.flashcat.cloud/monit/store/ruleset/create?app_key="

payload = {
    "type_ident": "prometheus",
    "note": "CPU 用量告警",
    "open_flag": 1,
    "payload": "[{\"prom_ql\":\"rate(cpu_usage[5m]) > 0.8\"}]"
}
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({
    type_ident: 'prometheus',
    note: 'CPU 用量告警',
    open_flag: 1,
    payload: '[{"prom_ql":"rate(cpu_usage[5m]) > 0.8"}]'
  })
};

fetch('https://api.flashcat.cloud/monit/store/ruleset/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/store/ruleset/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([
    'type_ident' => 'prometheus',
    'note' => 'CPU 用量告警',
    'open_flag' => 1,
    'payload' => '[{"prom_ql":"rate(cpu_usage[5m]) > 0.8"}]'
  ]),
  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/store/ruleset/create?app_key="

	payload := strings.NewReader("{\n  \"type_ident\": \"prometheus\",\n  \"note\": \"CPU 用量告警\",\n  \"open_flag\": 1,\n  \"payload\": \"[{\\\"prom_ql\\\":\\\"rate(cpu_usage[5m]) > 0.8\\\"}]\"\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/store/ruleset/create?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"type_ident\": \"prometheus\",\n  \"note\": \"CPU 用量告警\",\n  \"open_flag\": 1,\n  \"payload\": \"[{\\\"prom_ql\\\":\\\"rate(cpu_usage[5m]) > 0.8\\\"}]\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/monit/store/ruleset/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  \"type_ident\": \"prometheus\",\n  \"note\": \"CPU 用量告警\",\n  \"open_flag\": 1,\n  \"payload\": \"[{\\\"prom_ql\\\":\\\"rate(cpu_usage[5m]) > 0.8\\\"}]\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "id": 1,
    "type_ident": "prometheus",
    "note": "CPU 用量告警",
    "open_flag": 1,
    "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."
  }
}

​

限制说明

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

​

使用说明

• open_flag：0 仅创建者可见，1 账户内共享，2 公开。
• payload 为必填 JSON 字符串，包含告警规则定义。
• 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。

授权

app_key · string · query · 必填

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

请求体

application/json

创建规则集的请求体，所有字段均经服务端 Validate() 校验。

type_ident · string · 必填

该规则集适用的数据源类型标识符，如 prometheus。

note · string · 必填

规则集描述或标题。

payload · string · 必填

包含告警规则定义的 JSON 字符串。

open_flag · enum<integer>

共享范围：0 仅创建者可见，1 账户内共享，2 公开。省略时默认为 0。

可用选项: 0, 1, 2

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

单个规则仓库规则集。

Show child attributes