Flashcat API
FlashdutyNightingaleFlashcat帮助文档官网控制台
FlashdutyNightingaleFlashcat帮助文档官网控制台
  1. 告警规则
  • 介绍
  • /api/n9e 接口
    • 告警规则
      • 创建告警规则
        POST
      • 删除告警规则
        DELETE
      • 更新告警规则
        PUT
      • 获取规则列表
        GET
      • 获取业务组下告警规则列表
        GET
      • 导入告警规则
        POST
      • 测试 relabel 配置
        POST
      • 克隆到多台机器
        POST
      • 克隆告警规则到指定业务组
        POST
      • 更新告警规则指定字段内容
        PUT
      • 导入prom规则
        POST
    • 订阅规则
      • 获取订阅规则列表
      • 创建订阅规则
      • 修改订阅规则
      • 查询订阅规则
      • 删除订阅规则
    • 屏蔽规则
      • 创建屏蔽规则
      • 获取屏蔽规则
      • 修改屏蔽规则状态
      • 修改屏蔽规则详情
      • 删除屏蔽规则
    • 告警事件
      • 当前告警列表
      • 历史告警列表
      • 活跃告警-聚合规则
      • 修改告警聚合规则
      • 获取告警聚合规则
      • 删除告警聚合规则
      • 当前告警聚合信息
      • 取消认领告警
      • 告警事件通知结果
      • 认领告警
      • 事件所属的数据源列表
    • 通知规则
      • 新增通知规则
      • 修改通知规则
      • 删除通知规则
      • 通知规则列表
      • 通知规则详情
      • 通知规则配置测试
      • 自定义配置参数列表
      • 通知规则-测试事件处理
    • 机器列表
      • 获取机器列表
      • 获取机器列表-专业版
      • 绑定业务组
      • 获取标签列表
      • 绑定标签
      • 修改备注
      • 删除机器
    • 团队管理
      • 查询团队成员列表
      • 团队列表
      • 创建团队
      • 删除用户
      • 添加用户
    • 业务组管理
      • 创建业务组
      • 查询业务组列表
      • 查询业务组下团队列表
      • 修改业务组
      • 删除业务组
      • 业务组添加团队
      • 业务组删除团队
    • 用户管理
      • 创建 token
      • 获取 token 列表
      • 获取指定用户信息
      • 查询用户信息
      • 新增用户
      • 重置用户密码
      • 删除 token
      • 用户权限
      • 用户个人信息
      • 修改用户个人信息
      • 修改密码
      • 编辑用户
      • 删除用户
    • 权限管理
      • 获取角色列表
      • 获取所有操作权限点
      • 获取指定角色的权限点
      • 创建角色
      • 更新角色名
      • 更新角色权限
      • 删除角色
    • 采集配置
      • 创建测试任务
      • 查询测试任务结果
      • 创建采集配置
      • 更新采集配置
      • 删除采集配置
      • 采集配置列表
      • 获取采集配置
    • 网络设备
      • 批量更新网络设备字段
      • 删除网络设备
      • 创建网络设备
      • 网络设备详情
      • 更新网络设备
      • 导入网络设备
      • 网络设备列表
      • 批量绑定标签
      • 批量解绑标签
      • 获取设备的标签
      • 获取设备的模板ids
      • 批量绑定采集模板
      • 批量解绑采集模板
      • 获取组内所有标签
      • 创建测试任务
      • 获取设备的型号
    • 告警管理
    • 指标视图
      • 获取指标查询条件
      • 查询 Metric Filter
      • 添加 Metric Filter
      • 删除 Metric Filter
      • 更新 Metric Filter
      • 导入内置指标
      • 获取内置指标
      • 更新内置指标
      • 删除内置指标
      • 获取指标类型列表
      • 获取默认指标类型
      • 获取采集器列表
    • 告警自愈
      • 创建自愈脚本
      • 获取自愈脚本列表
      • 自愈脚本详情
      • 删除自愈脚本
      • 更新自愈脚本
      • 创建自愈任务
      • 获取自愈任务列表
      • 自愈任务详情
      • 获取自愈任务脚本错误输出stderr
      • 获取自愈任务脚本输出stdout
    • 采集配置
      • 获取数据采集列表
      • 创建采集配置
      • 更新采集状态
      • 更新采集配置
      • 删除数据采集
    • 网络设备
      • 获取网络设备列表
      • 新增网络设备
      • 更新网络设备
      • 批量更新设备
      • 导入设备
      • 删除网络设备
    • pingmesh
      • pingmesh-idc网络规则注册
      • pingmesh-idc网络规则修改
      • pingmesh-idc网络规则查询
      • pingmesh-idc网络规则删除
      • pingmesh-idc间ping规则配置注册
      • pingmesh-idc间ping规则配置查看
      • pingmesh-idc间ping规则配置修改
      • pingmesh-idc间ping规则配置删除
      • pingmesh-ping动作开关设置
      • pingmesh-ping动作开关查询
      • pingmesh-idc之间拓扑图
      • pingmesh-idc内netident拓扑
      • pingmesh-netident内server之间拓扑
      • pingmesh-查询指标历史数据
      • pingmesh-idc网络规则注册(From CMDB)
      • pingmesh-报警规则导出
    • 数据查询
      • 数据批量查询接口
      • table 数据批量查询接口
      • 查询数据库名称列表
      • 查询数据库表名称列表
      • 查询数据库表结构
      • sql 查询 table
      • sql 查询 graph
      • 查询数据库名称列表 Copy
      • 查询数据库表名称列表 Copy
    • 仪表盘
      • 仪表盘列表
      • 仪表盘详情
      • 新增仪表盘
      • 删除仪表盘
      • 修改仪表盘图表
      • 克隆仪表盘到指定业务组
      • 根据 bids 获取 board名称
    • 模板中心
      • 获取内置模板类型列表
      • 更新内置模板类型
      • 创建内置模板类型
      • 删除内置模板类型
      • 获取选中模板的某类模板
      • 获取选中模板的某类模板分类
      • 获取单个模板
      • 更新内置模板
      • 创建内置模板
      • 删除内置模板
      • 根据 uuids 获取内置模版
      • 根据 uuid 获取内置payload
    • 拨测任务API
      • 创建拨测任务
      • 更新拨测任务
      • 任务禁用
      • 任务启用
      • 任务删除
      • 查询业务组下的拨测任务列表
      • 任务详情查询
    • 集成仪表盘
      • 获取集成仪表盘列表
      • 更新集成仪表盘列表
      • 获取指定集成仪表盘
      • 获取集成仪表盘列表
      • 添加集成仪表盘
      • 编辑集成仪表盘
      • 删除集成仪表盘
    • 审计管理
      • 查看审计
    • 数据源
      • cloudwatch
        • 添加数据源-cloudwatch
        • 获取 cloudwatch region 列表
        • 获取 cloudwatch namespace 列表
        • 获取 cloudwatch metric name 列表
        • 获取 cloudwatch dimension key 列表
        • 获取 cloudwatch dimension value 列表
        • 查询数据--停用,统一走query-batch
        • 创建告警规则-cloudwatch 数据源
        • 仪表盘查询数据
      • victorialogs
        • 添加数据源-victorialogs
      • 添加数据源-sqlserver
      • 数据源查询
      • 获取数据源列表
      • 新增数据源
      • 数据源类型列表
      • 更新数据源状态
      • 删除数据源
      • 数据源授权
      • 数据源删除授权
      • 数据源查看授权
    • 全局屏蔽
      • 查询全局屏蔽列表
      • 查询指定全局屏蔽
      • 新建全局屏蔽
      • 修改指定全局屏蔽
      • 删除指定全局屏蔽
      • 批量更新全局屏蔽
    • 仪表盘标注
      • 添加仪表盘注释
      • 删除仪表盘注释
      • 获取仪表盘注释列表
      • 更新仪表盘注释
    • 通知媒介
      • 新增通知媒介
      • 修改通知媒介
      • 删除通知媒介
      • 通知媒介列表
      • 通知媒介详情
      • (简化)通知媒介列表
      • flushduty 协作空间列表
      • 通知媒介详情(get by)
      • 通知媒介列表LabelKey
      • 通知媒介类别列表
    • 消息模板
      • 新增消息模板
      • 修改消息模板
      • 删除消息模板
      • 消息模板列表
      • 消息模板详情
      • 事件预览
    • auth认证
      • 度小满
        • global_sso_way
        • 获取SSO跳转地址
        • SSO登陆回调
        • sso-config
      • login登陆
      • logout登出
      • 刷新token
      • 生成图形验证码
      • 验证码验证
      • 验证码开关
      • sso-config
      • rsa-config
      • 重定向
      • sso登陆回调
      • perms
    • metricsDesc
      • metrics释义
      • 添加metricsDesc
    • 通知配置-待下线
      • 通知模板-更新
      • 通知模板-获取
      • 通知模板-新增
      • 通知设置-回调地址-获取
      • 通知设置-回调地址-更新
      • 通知设置-通知脚本-获取
      • 通知设置-通知脚本-更新
      • 通知设置-通知媒介-更新
      • 通知设置-通知媒介-获取
      • 通知设置-联系方式-更新
      • 通知设置-联系方式-获取
      • 通知设置-SMTP设置-获取
    • 快捷视图(指标)
      • 获取视图列表
    • 变量设置
      • 创建变量
      • 读取变量列表
      • 更新变量
      • 删除变量
    • 单点登陆
      • 获取单点登陆配置列表
      • 更新单点登陆
    • 标签映射
      • 词表映射列表
      • 单个标签映射详情
      • 单个标签映射数据预览
      • 创建标签映射
      • 更新标签映射
      • 删除标签词表
      • 请求测试
      • 立即触发词表更新
      • 查看更新记录
    • 事件 Pipeline
      • 事件 pipeline 列表
      • 事件 Pipeline 详情
      • 新增事件 Pipeline 规则
      • 修改事件 Pipeline 规则
      • 删除事件 Pipeline 规则
      • 事件 Pipeline 规则测试
      • 事件 processor 规则测试
    • 用户信息--待删除(与用户管理重复)
      • 添加用户
      • 修改用户
      • 删除用户
  • /v1/n9e 接口
    • 用户管理
      • 用户列表
      • 创建
      • 修改用户
      • 删除用户
    • 告警规则
      • 创建告警规则
      • 创建单个告警规则
      • 根据产品查询告警规则列表
      • 根据id查询告警规则
      • 根据id更新告警规则
      • 删除告警规则
    • 告警事件
      • 生成告警事件
      • 查看告警历史
    • 告警屏蔽
      • 创建告警屏蔽
      • 查看告警屏蔽
      • 删除告警屏蔽
      • 告警屏蔽-测试屏蔽处理
    • 主机列表
      • 获取监控对象
      • 删除监控对象
      • 获取机器元信息
      • 修改监控对象业务组
    • 智能告警
      • 查询曲线的训练效果分数
    • 接收数据
      • /opentsdb/put
    • 采集配置
      • 获取采集测试任务
      • 上报采集测试结果
    • 用户组管理
      • 获取用户组信息
  1. 告警规则

创建告警规则

开发中
POST
/api/n9e/busi-group/{gid}/alert-rules
最后修改时间:2025-03-11 12:22:41

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Path 参数
gid
string 
业务组id
必需
Body 参数application/json
array of:
disabled
integer 
是否禁用
可选
name
string 
规则名称
必需
append_tags
array[string]
附加标签
可选
group_id
integer 
业务组ID
必需
note
string 
备注
可选
prod
string 
必需
产品类型(metric|host|log)
cate
string 
必需
规则数据类型,枚举类型有(prometheus|elasticsearch|mysql|host|aliyun-sls|tencent-cls)
datasource_queries
array [object {3}] 
数据源筛选
可选
match_type
string 
必需
匹配类型:精确匹配=0,模糊匹配=1,全部数据源=2
op
string 
必需
运算符:in|not in
values
array[integer]
匹配的数据源id
必需
datasource_value
string 
数据源id
可选
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_status
boolean 
生效配置启用
可选
notify_channels
array[string]
通知媒介
可选
notify_groups
array[string]
告警接收组
可选
notify_recovered
integer 
启用恢复通知
可选
recover_duration
integer 
留观时长(秒)
可选
notify_repeat_step
integer 
必需
重复通知间隔(分钟)
notify_max_number
integer 
通过最大发送次数
必需
callbacks
array[string]
回调地址
可选
annotations
object 
附加信息
可选
dashboard_url
string 
必需
cron_pattern
string 
执行频率
必需
prom_for_duration
integer 
持续时长 (s)
可选
enable_days_of_weeks
array [array] 
生效时间
可选
string 
可选
enable_stimes
array[string]
开始时间
可选
enable_etimes
array[string]
结束时间
可选
enable_in_bg
integer 
仅在本业务组生效
可选
extra_config
object 
可选
enrich_queries
array[string]
必需
notify_version
string 
可选
通知版本:0: old,1: new
notify_rule_ids
array[integer]
通知规则id列表
可选
示例
[
  {
    "disabled": 0,
    "name": "string",
    "append_tags": [
      "string"
    ],
    "group_id": 0,
    "note": "string",
    "prod": "string",
    "cate": "string",
    "datasource_queries": [
      {
        "match_type": "string",
        "op": "string",
        "values": [
          0
        ]
      }
    ],
    "datasource_value": "string",
    "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_status": true,
    "notify_channels": [
      "string"
    ],
    "notify_groups": [
      "string"
    ],
    "notify_recovered": 0,
    "recover_duration": 0,
    "notify_repeat_step": 0,
    "notify_max_number": 0,
    "callbacks": [
      "string"
    ],
    "annotations": {
      "dashboard_url": "string"
    },
    "cron_pattern": "string",
    "prom_for_duration": 0,
    "enable_days_of_weeks": [
      [
        "string"
      ]
    ],
    "enable_stimes": [
      "string"
    ],
    "enable_etimes": [
      "string"
    ],
    "enable_in_bg": 0,
    "extra_config": {
      "enrich_queries": [
        "string"
      ]
    },
    "notify_version": "string",
    "notify_rule_ids": [
      0
    ]
  }
]

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
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 '[
    {
        "disabled": 0,
        "name": "string",
        "append_tags": [
            "string"
        ],
        "group_id": 0,
        "note": "string",
        "prod": "string",
        "cate": "string",
        "datasource_queries": [
            {
                "match_type": "string",
                "op": "string",
                "values": [
                    0
                ]
            }
        ],
        "datasource_value": "string",
        "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_status": true,
        "notify_channels": [
            "string"
        ],
        "notify_groups": [
            "string"
        ],
        "notify_recovered": 0,
        "recover_duration": 0,
        "notify_repeat_step": 0,
        "notify_max_number": 0,
        "callbacks": [
            "string"
        ],
        "annotations": {
            "dashboard_url": "string"
        },
        "cron_pattern": "string",
        "prom_for_duration": 0,
        "enable_days_of_weeks": [
            [
                "string"
            ]
        ],
        "enable_stimes": [
            "string"
        ],
        "enable_etimes": [
            "string"
        ],
        "enable_in_bg": 0,
        "extra_config": {
            "enrich_queries": [
                "string"
            ]
        },
        "notify_version": "string",
        "notify_rule_ids": [
            0
        ]
    }
]'

返回响应

🟢200成功
application/json
Body
err
string 
必需
示例
{
  "err": ""
}

添加官方技术人员微信

在这里,获得使用上的任何帮助,快速上手企业告警一站式响应平台FlashDuty

微信扫码交流
修改于 2025-03-11 12:22:41
上一页
介绍
下一页
删除告警规则
Built with