接口调用地址:

/probe-api/event/receive

端口:

9090

请求方式:

POST

参数说明:

字段 类型 长度 必填 说明 举例
Node 字符串 64 true 设备唯一标识,一般为IP 192.168.1.1
NodeAlias 字符串 64 设备显示名称,例如”手机银行MySql01“
Manager 字符串 64 告警来源管理标识,一般由告警源传入,可在告警接入菜单查看具体映射字段,例如”Zabbix“、”Prometheus“ zabbix
Agent 字符串 64 true 事件接入probe key,对应事件接入的”接入key“字段,用于标识这条事件来源于哪个接入源 固定值f006afa0-0b97-11ec-89ad-2753267550e3
AlertGroup 字符串 255 true 指标组,例如”cpu“、”mem“、”disk“ Disk
AlertKey 字符串 255 true 告警key,指标,例如”cup.load[5m]“、”mem.usage“ Vfs.fs.size[c,used]
Severity 整型数字 true 事件级别,系统默认级别为灾难(5),严重(4),警告(2),一般严重(3),信息(1),未分类(0) 参考事件级别。
OldSeverity 整型数字 升降级前的事件级别
Summary 字符串 255 true 事件信息的具体描述,例如”[主机] MICHAEL Agent 客户端无法正常采集数据,系统可能宕机,告警值:1“ 事件描述信息
FirstOccurrence 时间戳 true 事件第一次被接收的时间 时间戳,长整型
LastOccurrence 时间戳 true 事件最后发生的时间,告警最近一次压缩、告警恢复的时间 时间戳,长整型
Tally 整型数字 true 事件重复发生的次数 可填默认值1
Acknoledged 整型数字 事件是否确认,0未确认,1确认
EventType 字符串 1 true 事件是否有恢复事件,P不可恢复,S可恢复事件 可填默认值S
EventSeverityType 整型数字 true 事件类型,1告警事件,2恢复事件 EventType是S时有效
isComponent 整型数字 发生事件的主机的类型,0组件告警,1设备告警
EventCategory 字符串 64 事件权限标识,设备分类名称,由分组策略自动生成,对应设备类别的名称,例如Switch
EventCategoryLabelText 字符串 255 事件分组(分类)显示名称,由分组策略自动生成,对应设备类别的显示名称,例如交换机
EventID 字符串 36 事件唯一ID,系统自动生成
RecoveredEventID 字符串 128 恢复事件ID
RecoveredStatus 整型数字 事件恢复状态,1未恢复,2已恢复 EventType=S时有效
BussinessZone 字符串 128 所属业务区域 子公司、分公司等
HostOrProxy 字符串 128 区分自定义监控和普通监控
AlertID 字符串 64 事件源下发的唯一id,告警事件和恢复事件的该id值应该一直,在Zabbix一般对应触发器ID
ParentEventCategory 字符串 64 发生事件的该设备的上级分组名称,由分组策略自动生成,例如该设备属于”Switch“,该值则为”网络设备“
ParentEventCategoryLabelText 字符串 255 发生事件的该设备的上级分组显示名称,由分组策略自动生成,例如该设备属于”交换机“,该值则为”网络设备“
ProbeKey 字符串 64 事件接入key,验证是否接收该事件

示例

{
“Agent”: “f006afa0-0b97-11ec-89ad-2753267550e3”,

“ProbeKey”: “f006afa0-0b97-11ec-89ad-2753267550e3”,

“Severity”: 4,

“EventSeverityType”: “2”,

“Node”: “192.168.178.166”,

“LastOccurrence”: 1685095831,

“EventCategory”: “Linux”,

“BussinessZone”: “xx集团”,

“Tally”: 1,

“isComponent”: 0,

“AlertGroup”: “Linux主动模板[生产]-内存”,

“AlertID”: “712727”,

“Summary”: “[主机]192.168.178.166 物理内存使用率10分钟平均值大于90%,告警值:89.71 %”,

“AlertKey”: “vm.memory.size[Usage]”,

“EventType”: “S”,

“FirstOccurrence”: 1685095831,

“NodeAlias”: “192.168.178.166”,

“Manager”: “zabbix”

}

返回数据结构

名称 类型 必选 约束 说明
errorMsg 字符串 true none
success 布尔 true none true:成功,false失败

示例

{

“errorMsg”: null,

“success”: true

}

事件级别说明:

告警级别 级别名称 级别颜色 说明
5 灾难 灾难,可能会带来损失
4 严重 严重事件
3 问题 一般问题
2 警告 可能是问题
1 通知 一般信息
0 未知 未知问题
作者:admin  创建时间:2024-12-10 16:19
最后编辑:admin  更新时间:2025-01-16 16:46