创建静默策略

创建一条静默策略，用于抑制满足特定条件的通知。

POST /channel/silence/rule/create

创建静默策略

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/channel/silence/rule/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel_id": 3521074710131,
  "rule_name": "Maintenance window silence",
  "description": "Silence all Info alerts during planned maintenance",
  "time_filter": {
    "start_time": 1773388800,
    "end_time": 1773414000
  },
  "filters": [
    [
      {
        "key": "severity",
        "oper": "IN",
        "vals": [
          "Info"
        ]
      }
    ]
  ],
  "is_directly_discard": false
}
'

import requests

url = "https://api.flashcat.cloud/channel/silence/rule/create?app_key="

payload = {
    "channel_id": 3521074710131,
    "rule_name": "Maintenance window silence",
    "description": "Silence all Info alerts during planned maintenance",
    "time_filter": {
        "start_time": 1773388800,
        "end_time": 1773414000
    },
    "filters": [[
            {
                "key": "severity",
                "oper": "IN",
                "vals": ["Info"]
            }
        ]],
    "is_directly_discard": 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({
    channel_id: 3521074710131,
    rule_name: 'Maintenance window silence',
    description: 'Silence all Info alerts during planned maintenance',
    time_filter: {start_time: 1773388800, end_time: 1773414000},
    filters: [[{key: 'severity', oper: 'IN', vals: ['Info']}]],
    is_directly_discard: false
  })
};

fetch('https://api.flashcat.cloud/channel/silence/rule/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/channel/silence/rule/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([
    'channel_id' => 3521074710131,
    'rule_name' => 'Maintenance window silence',
    'description' => 'Silence all Info alerts during planned maintenance',
    'time_filter' => [
        'start_time' => 1773388800,
        'end_time' => 1773414000
    ],
    'filters' => [
        [
                [
                                'key' => 'severity',
                                'oper' => 'IN',
                                'vals' => [
                                                                'Info'
                                ]
                ]
        ]
    ],
    'is_directly_discard' => 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/channel/silence/rule/create?app_key="

	payload := strings.NewReader("{\n  \"channel_id\": 3521074710131,\n  \"rule_name\": \"Maintenance window silence\",\n  \"description\": \"Silence all Info alerts during planned maintenance\",\n  \"time_filter\": {\n    \"start_time\": 1773388800,\n    \"end_time\": 1773414000\n  },\n  \"filters\": [\n    [\n      {\n        \"key\": \"severity\",\n        \"oper\": \"IN\",\n        \"vals\": [\n          \"Info\"\n        ]\n      }\n    ]\n  ],\n  \"is_directly_discard\": 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/channel/silence/rule/create?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"channel_id\": 3521074710131,\n  \"rule_name\": \"Maintenance window silence\",\n  \"description\": \"Silence all Info alerts during planned maintenance\",\n  \"time_filter\": {\n    \"start_time\": 1773388800,\n    \"end_time\": 1773414000\n  },\n  \"filters\": [\n    [\n      {\n        \"key\": \"severity\",\n        \"oper\": \"IN\",\n        \"vals\": [\n          \"Info\"\n        ]\n      }\n    ]\n  ],\n  \"is_directly_discard\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/channel/silence/rule/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  \"channel_id\": 3521074710131,\n  \"rule_name\": \"Maintenance window silence\",\n  \"description\": \"Silence all Info alerts during planned maintenance\",\n  \"time_filter\": {\n    \"start_time\": 1773388800,\n    \"end_time\": 1773414000\n  },\n  \"filters\": [\n    [\n      {\n        \"key\": \"severity\",\n        \"oper\": \"IN\",\n        \"vals\": [\n          \"Info\"\n        ]\n      }\n    ]\n  ],\n  \"is_directly_discard\": false\n}"

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

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "rule_id": "69db2f66a0fe7db6448b1503",
    "rule_name": "Test silence rule"
  }
}

{
  "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 次/秒
权限要求	协作空间管理（on-call）

授权

app_key · string · query · 必填

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

请求体

application/json

创建静默策略所需的参数。time_filter 与 time_filters 必须且只能设置其一,filters 不能为空。

channel_id · integer<int64> · 必填

所属协作空间 ID。

rule_name · string · 必填

策略名称,1 到 39 个字符。

Required string length: 1 - 39

priority · integer

匹配优先级,数值越小越优先。

description · string

策略描述,最多 500 个字符。

Maximum string length: 500

from_incident_id · string

当静默策略从故障创建时对应的源故障 ID。

time_filters · object[]

生效的周期性时间窗口列表,与 time_filter 互斥。

Show child attributes

time_filter · object

一次性时间窗口,使用 Unix 秒定义。

Show child attributes

filters · object[][]

或-与组合条件树。每个外层元素为一组 AND 条件,组内所有条件需同时满足。

Show child attributes

is_directly_discard · boolean

为 true 时被静默的告警将直接丢弃而非并入故障。

is_auto_delete · boolean

为 true 时，静默规则在时间窗结束后会被自动删除；默认为 false。

响应

200

application/json

成功

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

request_id · string · 必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

每个接口自己的业务 payload，详见各接口的 200 响应 schema。

Show child attributes