本文导读

展开导读

文档首页/ 应用运维管理 AOM/ API参考（安卡拉区域）/ API/ 事件告警/ 上报事件告警信息

上报事件告警信息

更新时间：2024-04-15 GMT+08:00

查看PDF

功能介绍

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

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。

表4 请求Body参数
参数	是否必选	参数类型	描述
events	是	Array of EventModel objects	事件或者告警详情。

表5 EventModel
参数	是否必选	参数类型	描述
starts_at	否	Long	事件或者告警产生的时间，CST毫秒级时间戳。
ends_at	否	Long	事件或者告警清除的时间，CST毫秒级时间戳，为0时表示未删除。
timeout	否	Long	告警自动清除时间。毫秒数，例如一分钟则填写为60000。默认清除时间为3天,对应数字为 259200 * 1000（即：3天 * 24小时 * 60分钟 * 60秒 * 1000毫秒）。
metadata	否	Map<String,String>	事件或者告警的详细信息，为键值对形式。最大可扩展到30个子字段。必须字段为：- 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,String>	事件或者告警附加字段，可以为空。
id	否	String	事件或者告警id，系统会自动生成，上报无须填写该字段。

响应参数

无

请求示例

上报一条名为test的告警。

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

{
  "events" : [ {
    "starts_at" : 1579420868000,
    "ends_at" : 1579420868000,
    "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" : "possible cause",
      "alarm_fix_suggestion_zh_cn" : "fix suggestion",
      "message" : "details"
    }
  } ]
}

响应示例

无

状态码

状态码	描述
204	OK 请求响应成功。
400	BadRequest 非法请求。建议直接修改该请求，不要重试该请求。
401	Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。
403	Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。
500	InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。
503	ServiceUnavailable 被请求的服务无效。建议直接修改该请求，不要重试该请求。

错误码

请参见错误码。

父主题： 事件告警

上一篇：统计事件告警信息

下一篇：Agent

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消