跳转至

REST API 集成

睿象云Cloud Alert提供 3 种通用方式集成您的告警:Webhook 集成、邮箱集成REST API


Webhook 集成 CA 步骤

  1. 创建应用 在 CA 界面创建 Webhook 应用,并获取 appkey

  2. 在第三方工具/自行开发的监控工具中调用 Webhook 应用获取到的URL 推送告警到 Cloud Alert Webhook 相关配置参数及示例参考下方:接口、参数列表、告警示例等。

接口调用示例说明

说明
接口(http) http://api.aiops.com/alert/api/event/webhook/{appKey}
接口 (https) https://caweb.aiops.com/alert/api/event/webhook/{appKey}
调用方法 POST
接入数据格式示例(body) {"eventId": "12345", "eventType": "trigger", "alarmName": "FAILURE for production/HTTP on machine 192.168.0.253", "entityName": "host-192.168.0.253", "entityId": "host-192.168.0.253", "priority": 1, "alarmContent": { "ping time": "2500ms", "load avg": 0.75 }, "details": { "details":"haha" }, "contexts": [ { "type": "link", "text": "generatorURL", "href": "http://www.baidu.com" }, { "type": "link", "href": "http://www.sina.com", "text": "CPU Alerting" }, { "type": "image", "src": "http://www.baidu.com/a.png" }] }

提示

接口地址中,"{appKey}":"--" --处填入您新建应用时生成的appkey

接入数据映射配置参数说明

参数 必须 备注信息
动态取值 可选 默认不勾选,勾选后需要做出选择,可多选;请求报文体中存在多个告警需要解析时,需要给出动态取值的标识
开启分组合并 可选 默认关闭,多个开告警会拆开多条进入平台进行分派流转通知;开启后多个告警会合并到一条主告警下分派流转通知,在压缩告警中可见
告警状态 必填 用来标识告警的状态是触发还是关闭,触发非必填,默认就是触发,关闭需要给出具体的标识
告警标题 必填 表示当前问题的概况性信息
告警内容 必须 可以详细说明告警问题,多个信息组合可以用英文逗号分隔
事件ID 可选 用来唯一标识此条告警信息,外部API关闭告警的标识,多个信息组合可以用英文逗号分隔
告警对象 必须 发生告警的对象
级别 必填 标识当前告警的重要程度;标识字段必选,值对应关系不填写时,默认为警告,建议填写完成的对应关系
发生时间 可选 非必填项,如不填写,将以服务接收到告警的时间为触发时间
恢复时间 可选 非必填项,如不填写,将以服务接收到恢复状态告警的时间为恢复时间
主机 可选 用来展示发生告警主机信息,非必填项
服务 可选 用来展示发生告警的服务信息,非必填项
上下文 可选 上下存储数据格式是json对象数据组,支持外链和图片两种方式
自定义标签 可选 根据实际场景添加标签名称和取值信息,可用于后续所有规则的定义和展示