跳转到主要内容
POST
/
monit
/
rule
/
update
/
fields
批量更新规则字段
curl --request POST \
  --url 'https://api.flashcat.cloud/monit/rule/update/fields?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    50001,
    50002
  ],
  "fields": [
    "enabled"
  ],
  "enabled": false
}
'
import requests

url = "https://api.flashcat.cloud/monit/rule/update/fields?app_key="

payload = {
"ids": [50001, 50002],
"fields": ["enabled"],
"enabled": False
}
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({ids: [50001, 50002], fields: ['enabled'], enabled: false})
};

fetch('https://api.flashcat.cloud/monit/rule/update/fields?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/update/fields?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([
'ids' => [
50001,
50002
],
'fields' => [
'enabled'
],
'enabled' => false
]),
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/update/fields?app_key="

payload := strings.NewReader("{\n \"ids\": [\n 50001,\n 50002\n ],\n \"fields\": [\n \"enabled\"\n ],\n \"enabled\": false\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/update/fields?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n 50001,\n 50002\n ],\n \"fields\": [\n \"enabled\"\n ],\n \"enabled\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/monit/rule/update/fields?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 \"ids\": [\n 50001,\n 50002\n ],\n \"fields\": [\n \"enabled\"\n ],\n \"enabled\": false\n}"

response = http.request(request)
puts response.read_body
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": [
    {
      "name": "CPU 过高",
      "message": ""
    },
    {
      "name": "磁盘告警",
      "message": ""
    }
  ]
}
{
"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

使用说明

  • fields 数组中指定要更新的字段名,如 ["enabled", "channel_ids"]
  • 仅更新指定字段,其他字段保持不变。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json
ids
integer<uint64>[]
必填

要更新的规则 ID 列表。

fields
string[]
必填

要更新的字段名列表。

labels
object
ds_type
string
ds_list
string[]
ds_ids
integer<uint64>[]
enabled
boolean
debug_log_enabled
boolean
cron_pattern
string
timezone
string
默认值:Asia/Shanghai

告警规则执行时区,IANA 时区名,默认 Asia/Shanghai

delay_seconds
integer
enabled_times
object[]
annotations
object
description
string
channel_ids
integer<uint64>[]
repeat_interval
integer<int64>
repeat_total
integer<int64>

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object[]
必填

批量规则操作中每条规则的处理结果列表。