Flashcat API

新增通知规则

POST

https://api.flashcat.cloud/api/n9e/notify-rules

最后修改时间：2025-05-20 06:06:44

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.flashcat.cloud/api/n9e/notify-rules' \
--header 'Content-Type: application/json' \
--data-raw '[{
  "name": "High CPU Alert",
  "description": "Alert when CPU usage exceeds 80%",
  "enable": true,
  "user_group_ids": [1,2],
  "notify_configs": [
    {
      "channel_id": 1,
      "template_id": 2,
      "params": {
        "threshold": 80
      },
      "severities": [1, 2],
      "time_ranges": [
        {
          "start": "08:00",
          "end": "18:00",
          "week": [1, 2]
        }
      ],
      "label_keys": [
        {
          "key": "env",
          "op": "==",
          "value": "production"
        }
      ]
    }
  ]
}]'

响应示例

{
    "dat": [
        {
            "id": 1,
            "name": "High CPU Alert",
            "description": "Alert when CPU usage exceeds 80%",
            "enable": true,
            "user_group_ids": [
                1,
                2
            ],
            "notify_configs": [
                {
                    "channel_id": 1,
                    "template_id": 2,
                    "params": {
                        "threshold": 80
                    },
                    "severities": [
                        1,
                        2
                    ],
                    "time_ranges": [
                        {
                            "start": "08:00",
                            "end": "18:00",
                            "week": [
                                1,
                                2
                            ]
                        }
                    ],
                    "label_keys": [
                        {
                            "key": "env",
                            "op": "==",
                            "value": "production"
                        }
                    ]
                }
            ]
        }
    ],
    "err": ""
}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

array of:

name

string

必需

description

string

可选

enable

boolean

可选

user_group_ids

array[integer]

必需

notify_configs

array [object {6}]

必需

channel_id

integer

必需

template_id

integer

可选

params

object

可选

不同的媒介填写不同的字段，飞书可以填写

{
"access_token": "e79616d927f25e6xxxx",
"bot_name": "测试专用"
}

severities

array[integer]

可选

选择要对哪个等级的告警事件进行通知，只有勾选上的级别，才会被通知。如果三个等级都没有勾选，这个媒介就匹配不到告警事件了，相当于禁用了这个媒介

time_ranges

array [object {3}]

可选

通知规则可以限制仅在部分时段生效，不配置表示不做限制

label_keys

array [object {3}]

可选

通知规则可以限制仅对符合条件（通过事件标签做筛选）的部分告警事件生效，不配置表示不做限制

pipeline_configs

array [object {2}]

可选

pipeline_id

integer

可选

事件管道的 id，会根据配置，对告警事件里的属性进行处理

enable

boolean

可选

示例

返回响应

🟢200成功

application/json

Body

array of:

name

string

必需

description

string

可选

enable

boolean

可选

user_group_ids

array[integer]

必需

notify_configs

array [object {6}]

必需

channel_id

integer

必需

template_id

integer

可选

params

object

可选

不同的媒介填写不同的字段，飞书可以填写

{
"access_token": "e79616d927f25e6xxxx",
"bot_name": "测试专用"
}

severities

array[integer]

可选

time_ranges

array [object {3}]

可选

通知规则可以限制仅在部分时段生效，不配置表示不做限制

label_keys

array [object {3}]

可选

通知规则可以限制仅对符合条件（通过事件标签做筛选）的部分告警事件生效，不配置表示不做限制

pipeline_configs

array [object {2}]

可选

pipeline_id

integer

可选

事件管道的 id，会根据配置，对告警事件里的属性进行处理

enable

boolean

可选

事件所属的数据源列表

修改通知规则