文档首页/ 应用运维管理 AOM/ API参考（吉隆坡区域）/ API/ 告警/ 上报事件告警信息
更新时间：2024-08-02 GMT+08:00
在线调试
CLI示例
查看PDF
分享

上报事件告警信息

功能介绍

该接口用于上报对应用户的事件、告警。

调用方法

请参见如何调用API。

URI

PUT /v2/{project_id}/push/events

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户从IAM申请到的projectid，一般为32位字符串。
表2 Query参数

参数

是否必选

参数类型

描述

action

否

String

接口请求动作。action=clear代表清除告警，不传或者传其他值默认为上报动作。

枚举值：

  • clear

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。

Content-Type

是

String

指定类型为application/json。

枚举值：

  • application/json

x-enterprise-prject-id

否

String

告警所属的企业项目id。
表4 请求Body参数

参数

是否必选

参数类型

描述

events

是

Array of EventModel objects

事件或者告警详情。
表5 EventModel

参数

是否必选

参数类型

描述

starts_at

否

Long

事件或者告警产生的时间，CST毫秒级时间戳。

ends_at

否

Long

事件或者告警清除的时间，CST毫秒级时间戳，为0时表示未删除。

timeout

否

Long

告警自动清除时间。毫秒数，例如一分钟则填写为60000。默认清除时间为3天,对应数字为 4320 * 1000（即：3天 * 24小时 * 60分钟 * 1000毫秒）。

metadata

否

Map<String,String>

事件或者告警的详细信息，为键值对形式。必须字段为：

  • event_name：事件或者告警名称,类型为String；

  • event_severity：事件级别枚举值。类型为String，四种类型 "Critical", "Major", "Minor", "Info"；

  • event_type：事件类别枚举值。类型为String，event为告警事件，alarm为普通告警；

  • resource_provider：事件对应云服务名称。类型为String；

  • resource_type：事件对应资源类型。类型为String；

  • resource_id：事件对应资源信息。类型为String。

annotations

否

Map<String,Object>

事件或者告警附加字段，可以为空。

attach_rule

否

Map<String,Object>

事件或者告警预留字段，为空。

id

否

String

事件或者告警id，系统会自动生成，上报无须填写该字段。

响应参数

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

响应码。

error_msg

String

调用失败响应信息描述。

error_type

String

调用失败类型。

trace_id

String

请求id

请求示例

上报一条名称为“test”、事件等级为“Major”且告警源为“ecs”的告警。

https://{EndPoint}/v2/{project_id}/push/events

{
  "events" : [ {
    "starts_at" : 1605232501000,
    "timeout" : 60000,
    "metadata" : {
      "event_name" : "test",
      "event_severity" : "Major",
      "event_type" : "alarm",
      "resource_provider" : "ecs",
      "resource_type" : "vm",
      "resource_id" : "ecs123"
    },
    "annotations" : {
      "alarm_probableCause_zh_cn" : "可能原因",
      "alarm_fix_suggestion_zh_cn" : "修复建议",
      "message" : "告警详情"
    },
    "attach_rule" : { }
  } ]
}

响应示例

状态码： 400

BadRequest 非法请求。建议直接修改该请求，不要重试该请求。

{
  "error_code" : "AOM.0400",
  "error_msg" : "parse eventParam failed",
  "error_type" : "SC_BAD_REQUEST"
}

状态码

状态码

描述

204

OK 请求响应成功。

400

BadRequest 非法请求。建议直接修改该请求，不要重试该请求。

401

Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。

403

Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。

500

InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。

503

ServiceUnavailable 被请求的服务无效。建议直接修改该请求，不要重试该请求。

错误码

请参见错误码。

父主题： 告警