Alert告警接入规范
最近更新时间: 2023-02-16 09:36:37
如果需要接入第三方的告警，Alert可以通过 REST API的方式接入的告警，需要按照接口的接入规范和告警字段设置进行告警接入Alert。
调用方式
| url | http://oss.yun.ccb.com/alert/openapi/v2/create?apikey=7e6c9715ab394722a51706b68cbdb9c6&app_key=b0p38x7pco66iunjhquujnriwe230ck2 apikey 用于标识租户，app_key用于标识应用 |
| 调用方式 | post |
| header | Content-Type、application/json;charset=utf-8 |
| body | { "severity": 3, "name": "system.mem.pct_usage-CPU利用率", "description": "内存使用率超过80%", "occur_time": 1490251916807, "entity_name": "PC Server", "entity_addr": "10.2.1.2", "merge_key": "entity_name,name", "identify_key": "entity_name,entity_addr", "type": "metric", "networkDomain": "defaultZone", "properties": [ { "val": "system.mem.pct_usage", "code": "metricname", "name": "METRIC_NAME" } ] } |
| 返回码 | 500 apikey错误 Deserializer threw unexpected exception. 1 400 appkey错误 Bad request from client. Event authed failed 200 接收成功 |
| 参数 | 是否必须 | 是否可空 | 备注 |
| severity | 可选 | 可为空 | 告警级别: 严重:3, 错误:2,警告: 1, 恢复: 0 |
| name | 可选 | 可为空 | 告警名称 |
| description | 必须 | 不可为空 | 告警描述 |
| occur_time | 可选 | 可为空 | 发生时间,不填默认现在时间 |
| entity_name | 必须 | 不可为空 | 告警对象，比如X86服务器(PCServer)；虚拟机(VM); Linux ;Windows; Mysql ;Oracle等等 |
| entity_addr | 可选 | 可为空 | 告警对象地址 |
| merge_key | 可选 | 可为空 | 指定用于告警合并的字段，如果有多个字段请用逗号隔开。可选范围: entity_name,entity_addr,app_key,name,properties中的字段的code |
| identify_key | 可选 | 可为空 | 用于定位统一资源库(cmdb)的资源，如果有多个字段请用逗号隔开。默认设置：entity_addr这个字段就可 |
| networkDomain | 可选 | 可为空 | 网络域：defaultZone 为默认域的Code信息，为了更好的区分告警所属的网络域信息,此信息可以在ANT产品中查询，查看设备纳管所分配的网络域信息，不填写的情况，默认把告警划分到默认域。 |
| Type | 可选 | 可为空 | 告警类型：event 事件告警，metric 指标告警，默认为event(不传或为空都可以) |
| properties | 可选 | 可为空 | 告警的扩展字段，请使用 name,code,val的形式，当 type 为 metric时，如果可以传递指标编码，可增加 name为METRIC_NAME，code 填metricname，val 填写报警指标的code |