Flashcat API

通知规则-测试事件处理

开发中

POST

/api/n9e/notify-rule/event-pipelines-tryrun

最后修改时间：2025-05-08 10:02:24

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Body 参数application/json

event_id

integer

告警事件 ids

必需

pipeline_configs

object

必需

pipeline_id

integer

必需

enable

boolean

必需

示例

{
  "event_ids": [
    1,
    3
  ],
  "notify_config": {
    "channel_id": 1,
    "template_id": 2,
    "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-rule/event-pipelines-tryrun' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event_ids": [
        1,
        3
    ],
    "notify_config": {
        "channel_id": 1,
        "template_id": 2,
        "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

dat

object (告警信息)

必需

integer

告警id

可选

cate

string

监控类型

必需

is_recovered

integer

是否恢复

可选

datasource_id

integer

数据源id

可选

cluster

string

数据源

可选

group_id

integer

业务组id

可选

group_name

string

业务组名称

可选

hash

string

hash

必需

rule_id

integer

规则id

可选

rule_name

string

规则名称

可选

rule_note

string

规则备注

可选

rule_prod

string

规则分类

可选

rule_algo

string

可选

severity

integer

告警级别

可选

prom_for_duration

integer

告警持续时长

可选

prom_ql

string

PromQL

可选

rule_config

object

规则配置

可选

prom_eval_interval

integer

规则执行频率

可选

callbacks

array[string]

回调地址

可选

runbook_url

string

可选

notify_recovered

integer

通知留观时长(秒)

可选

notify_channels

array[string]

通知媒介列表

可选

notify_groups

array[string]

告警接收组

可选

notify_groups_obj

array[string]

可选

target_ident

string

标识

可选

target_note

string

备注

可选

trigger_time

integer

触发时间

可选

trigger_value

string

目标值

可选

recover_time

integer

恢复时间

可选

last_eval_time

integer

可选