Flashcat API

创建告警规则

开发中

POST

https://api.flashcat.cloud/api/n9e/busi-group/{gid}/alert-rules

最后修改时间：2025-03-11 12:22:41

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.flashcat.cloud/api/n9e/busi-group//alert-rules' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "name": "string",
        "append_tags": [
            "string"
        ],
        "disabled": 0,
        "group_id": 0,
        "note": "string",
        "prod": "string",
        "cate": "string",
        "datasource_queries": [
            {
                "match_type": "string",
                "op": "string",
                "values": [
                    0
                ]
            }
        ],
        "cron_pattern": "string",
        "prom_for_duration": 0,
        "rule_config": {
            "inhibit": true,
            "override_global_webhook": true,
            "queries": [
                {
                    "key": "string",
                    "op": "string",
                    "values": [
                        "string"
                    ],
                    "keys": {
                        "labelKey": "string",
                        "metricKey": "string",
                        "valueKey": "string"
                    },
                    "prom_ql": "string",
                    "ref": "string",
                    "severity": 0,
                    "unit": "string",
                    "var_config": {
                        "child_var_configs": {
                            "param_val": [
                                {}
                            ]
                        },
                        "param_val": [
                            {
                                "id": "string",
                                "name": "string",
                                "param_type": "string",
                                "query": [
                                    "string"
                                ]
                            }
                        ]
                    },
                    "var_enabled": true,
                    "recover_config": {
                        "judge_type": 0
                    },
                    "recover_exp": "string"
                }
            ],
            "task_tpls": [
                {
                    "tpl_id": "string",
                    "tpl_name": "string",
                    "host": [
                        "string"
                    ]
                }
            ],
            "severity": "string",
            "prom_ql": "string",
            "triggers": [
                {
                    "type": "string",
                    "duration": 0,
                    "percent": 0,
                    "severity": 0
                }
            ],
            "algo_params": {},
            "event_relabel_config": [
                {
                    "action": "string",
                    "regex": "string",
                    "replacement": "string",
                    "separator": "string",
                    "source_labels": [
                        "string"
                    ],
                    "target_label": "string"
                }
            ]
        },
        "enable_in_bg": 0,
        "enable_etimes": [
            "string"
        ],
        "enable_stimes": [
            "string"
        ],
        "enable_days_of_weeks": [
            [
                "string"
            ]
        ],
        "recover_duration": 0,
        "annotations": {
            "dashboard_url": "string"
        },
        "notify_recovered": 0,
        "notify_version": "string",
        "notify_rule_ids": [
            0
        ],
        "extra_config": {
            "enrich_queries": [
                "string"
            ]
        },
        "notify_repeat_step": 0,
        "notify_max_number": 0,
        "notify_channels": [
            "string"
        ],
        "notify_groups": [
            "string"
        ],
        "callbacks": [
            "string"
        ]
    }
]'

响应示例

{
  "err": ""
}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Path 参数

gid

string

业务组id

必需

Body 参数application/json

array of:

name

string

规则名称

必需

append_tags

array[string]

附加标签

可选

disabled

integer

是否禁用

可选

group_id

integer

业务组ID

必需

note

string

备注

可选

prod

string

必需

产品类型(metric|host|log)

cate

string

必需

datasource_queries

array [object {3}]

数据源筛选

可选

match_type

string

必需

匹配类型：精确匹配=0，模糊匹配=1，全部数据源=2

string

必需

运算符：in|not in

values

array[integer]

匹配的数据源id

必需

cron_pattern

string

执行频率

必需

prom_for_duration

integer

持续时长 (s)

可选

rule_config

object (规则config)

规则配置

必需

inhibit

boolean

是否开启抑制

可选

override_global_webhook

boolean

覆盖全局回调

可选

queries

array [object {12}]

规则条件

可选

task_tpls

array [object {3}]

告警自愈

可选

severity

string

街区级别

可选

prom_ql

string

可选

triggers

array [object {4}]

可选

algo_params

object

可选

event_relabel_config

array [object {6}]

事件relabel

可选

enable_in_bg

integer

仅在本业务组生效

可选

enable_etimes

array[string]

结束时间

可选

enable_stimes

array[string]

开始时间

可选

enable_days_of_weeks

array [array]

生效时间

可选

string

可选

recover_duration

integer

留观时长（秒）

可选

annotations

object

附加信息

可选

dashboard_url

string

必需

notify_recovered

integer

启用恢复通知

可选

notify_version

string

可选

通知版本：0: old，1: new

notify_rule_ids

array[integer]

通知规则id列表

可选

extra_config

object

可选

enrich_queries

array[string]

必需

notify_repeat_step

integer

必需

重复通知间隔(分钟)

notify_max_number

integer

通过最大发送次数

必需

notify_channels

array[string]

可选

不推荐使用，后面会下线，推荐使用通知规则
通知媒介

notify_groups

array[string]

可选

不推荐使用，后面会下线，推荐使用通知规则
告警接收组

callbacks

array[string]

可选

不推荐使用，后面会下线，推荐使用通知规则
回调地址

示例

返回响应

🟢200成功

application/json

Body

err

string

必需

介绍

删除告警规则