【外部事件监控器】事件接受¶

POST /api/v1/push-events/{secret}/{subUri}

概述¶

接收一个外部事件, 并根据事件生成对应事件数据。注意, 当secret和subUri信息与监控器中记录的信息不一致时, 该事件将被忽略。

路由参数¶

参数名	类型	必选	说明
secret	string	Y	外部事件监控器secret(对应新建监控器中的`secret`字段; 该值与监控器配置不一致时, 将忽略该事件)
subUri	string	Y	外部事件监控器subUri(对应新建监控器中的`jsonScript`.`subUri` 字段; 该值与监控器配置不一致时, 将忽略该事件)

Body 请求参数¶

参数名	类型	必选	说明
event	json	Y	事件数据允许为空: False
event.status	string		事件状态 $required: True 可选值: ['critical', 'error', 'warning', 'info', 'ok']
event.title	string		事件标题允许为空: False $required: False
event.message	string		事件内容允许为空: False $required: False
event.dimension_tags	json		维度标签，如：{ 'host': 'WebServer' } 允许为空: False $required: False
event.check_value	float		检测值允许为空: False $required: False
extraData	json		额外数据最终会加入事件的df_meta.extra_data字段中允许为空: False $required: False

参数补充说明¶

参数说明:

body请求参数主体结构说明

参数名	参数类型	是否必传	参数说明
event	json	是	事件数据
extra_data	json	否	额外数据最终会加入事件的df_meta.extra_data字段中符合key:value即可

event请求参数主体结构说明

参数名	参数类型	是否必传	参数说明
status	string	是	事件状态，可选：critical、error、warning、info、ok
title	string	否	事件标题
message	string	否	事件内容
dimension_tags	json	否	维度标签，如：{ "host": "WebServer" }
check_value	float	否	检测值

请求例子¶

curl 'https://openapi.guance.com/api/v1/push-events/<secret>/<subUri>' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  --data-raw '{"event":{"status":"warning","title":"外部事件监控器测试1","message":"你好，这是外部事件监控器的message","dimension_tags":{"heros":"caiwenji"},"check_value":20},"extra_data":{"name":"xxxxxxxx"}}' \
  --compressed

响应¶

{
    "code": 200,
    "content": {
        "data": {},
        "error": 200,
        "message": "",
        "ok": true,
        "reqCost": 458,
        "reqTime": "2023-10-19T07:26:30.743Z",
        "respTime": "2023-10-19T07:26:31.201Z",
        "traceId": "7390361544936022329"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "7390361544936022329"
}