Flashcat API

新增通知规则

开发中

POST

/api/n9e/notify-rules

最后修改时间：2025-02-19 08:28:04

请求参数

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

可选

severities

array[integer]

可选

time_ranges

array [object {3}]

可选

label_keys

array [object {3}]

可选

pipeline_configs

array [object {2}]

必需

pipeline_id

integer

必需

enable

boolean

必需

示例

[
  {
    "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"
          }
        ]
      }
    ]
  }
]

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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"
        }
      ]
    }
  ]
}]'

返回响应

🟢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

可选

severities

array[integer]

可选

time_ranges

array [object {3}]

可选

label_keys

array [object {3}]

可选

pipeline_configs

array [object {2}]

必需

pipeline_id

integer

必需

enable

boolean

必需

示例

{
  "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": ""
}

修改于 2025-02-19 08:28:04

事件所属的数据源列表

修改通知规则