告警 Event

---

title: "告警 Event"
description: "Flashduty 告警 Event API 文档。"
date: "2024-11-20T10:00:00+08:00"
url: "https://developer.flashcat.cloud/zh/flashduty/event-api/alert-event"

---

通过标准 API 推送自有系统告警事件到快猫星云，实现告警事件自动化降噪处理。

请求描述

推送地址

POST https://api.flashcat.cloud/event/push/alert/standard

请求参数：

请求响应

字段名称	必选	类型	描述
request_id	是	string	请求 ID，用于链路追踪
error	否	Error	错误描述，仅当出现错误时返回
data	否	interface{}	数据内容，可能为任何格式，具体参考 API 定义

Error:

字段名称	必选	类型	描述
code	是	string	错误码，枚举值参考 Code
message	否	string	错误描述

Code:

错误码	HTTP Status	描述
InvalidParameter	400	参数错误
InvalidContentType	400	Conten-Type 不支持
MethodNotAllowed	400	HTTP Method 不支持
Unauthorized	401	登录认证未通过
AccessDenied	403	权限认证未通过
RequestTooFrequently	429	请求过于频繁
RouteNotFound	404	请求 Method+Path 未匹配
ResourceNotFound	400	账户未购买资源，先前往费用中心线操作下单
NoLicense	400	账户无充足订阅 License，先前往费用中心升级或购买订阅
InternalError	500	内部或未知错误

请求示例

请求：

curl -X POST 'https://api.flashcat.cloud/event/push/alert/standard?integration_key=$key' \
-H 'Content-Type: application/json' \
-d '{
    "event_status": "Warning",
    "alert_key": "64f6b9df2007be4b0bfe56f6",
    "description": "cpu idle low than 20%",
    "title_rule": "$cluster::$resource::$check",
    "labels": {
        "resource":"es.nj.01",
        "check":"cpu.idle<20%",
        "service": "engine",
        "cluster":"nj",
        "metric":"node_cpu_seconds_total"
    }
}' -v

成功响应：

{
    "request_id": "0ace00116215ab4ca0ec5244b8fc54b0"
}

失败响应：

{
    "request_id": "0ace00116215abc0ba4e52449bd305b0",
    "error": {
        "code": "InvalidParameter",
        "message": "integration_key is not a valid one"
    }
}

最佳实践

1. 当告警状态发生变更时，向快猫星云发送事件
2. 当告警恢复时，发送一个 status 为 Ok 的事件，来关闭告警。否则，告警将一直处于打开状态。如果您的告警系统没有恢复事件，建议您手动发送恢复事件
3. 标签是事件的描述，应尽量丰富标签内容（发送时指定，或者通过配置标签增强规则来生成新的标签），比如：
   • 告警的发生来源，如 host，cluster，check 或 metric 等
   • 告警的归属信息，如 team，owner 等
   • 告警的类别信息，如 class（api，db，net）