标准告警事件集成指引
操作步骤
在 Flashduty
使用专属集成
展开
1.
2.
3.
4.
使用共享集成
展开
1.
2.
3.
路由
进行更多路由规则的配置)。4.
5.
一、请求描述
请求方式
POST, Content-Type:"application/json"
请求参数:
Headers:
字段 | 必含 | 类型 | 释义 |
---|---|---|---|
Content-Type | 是 | string | 固定值:application/json 。 |
Query Strings:
字段 | 必含 | 类型 | 释义 |
---|---|---|---|
integration_key | 是 | string | 集成秘钥,用于访问控制。添加集成后获得。 |
Payload:
字段 | 必含 | 类型 | 释义 |
---|---|---|---|
title_rule | 是 | string | 告警标题,不超过512 个字符,超出后将自动截断。支持根据告警内容动态生成标题,生成规则请参考 定制故障标题。 |
event_status | 是 | string | 告警状态。 枚举值( 首字母大写 ):Critical:严重,Warning:警告,Info:提醒,Ok:恢复。当指定为Ok时,意味着对告警进行自动恢复。 |
alert_key | 否 | string | 告警标识,用于对已经存在的告警进行更新或自动恢复。 您可以自定义此值,但不可超过 255 个字符。您也可以依赖系统自动生成,该值会在响应中返回。如果您上报的是恢复事件,则此值必须存在。 |
description | 否 | string | 告警描述,不超过2048 个字符,超出后将自动截断。 |
labels | 否 | map | 告警标签集合,key 为标签名称,value 为标签值: 1. 标签的 key 和 value 均为 string 类型,区分大小写。 2. 标签的 key 不要超过 128 个字符,遵循Prometheus标签命名规范。value 不超过2048 个字符,超出后将自动截断。3. 至多传入 50 个标签。标签内容参考 最佳实践。示例:"resource": "171.26.23.22", "check": "api latency > 500ms" |
请求响应
字段名称 | 必选 | 类型 | 描述 |
---|---|---|---|
request_id | 是 | string | 请求 ID,用于链路追踪 |
error | 否 | Error | 错误描述,仅当出现错误时返回 |
data | 否 | Data | 上报信息 |
字段名称 | 必选 | 类型 | 描述 |
---|---|---|---|
alert_key | 否 | string | 告警标识,可依据此值上报恢复事件。如果您上报事件时,已经指定了 alert_key,则此值不变。否则,系统自动生成。 |
字段名称 | 必选 | 类型 | 描述 |
---|---|---|---|
code | 是 | string | 错误码,枚举值参考 Code |
message | 否 | string | 错误描述 |
错误码 | 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 | 内部或未知错误 |
二、请求示例
{
"request_id": "0ace00116215ab4ca0ec5244b8fc54b0",
"data": {
"alert_key": "9qJ798NJoXS4UMVB5SHsNj"
}
}
{
"request_id": "0ace00116215abc0ba4e52449bd305b0",
"error": {
"code": "InvalidParameter",
"message": "integration_key is not a valid one"
}
}
三、最佳实践
1.
2.
3.
四、常见问题
为什么在Flashduty没有收到告警?
在 Flashduty
1.
2.
在您的系统
1.
2.
3.
为什么推送请求成功?但是没有看到新告警或故障产生?
1.
2.
3.
4.
修改于 2025-03-27 07:28:14