上报事件

功能介绍

事件监控为您提供上报自定义事件的接口，方便您将业务产生的异常事件或重要变更事件采集上报到云监控服务。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /V1.0/{project_id}/events

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	项目ID。 获取方式请参见获取项目ID。

• 样例

  POST https://{云监控的endpoint}/V1.0/{project_id}/events

请求消息

说明：

事件的time、project_id、event_source、event_name、event_type、event_state、event_level、event_user、resource_id、resource_name字段相同时，则视为同一条事件。

• 请求参数

  表2 参数说明

  名称	参数类型	是否必选	说明
  [数组元素]	Array of EventItem objects	是	事件列表。

  表3 EventItem字段数据结构说明

  名称	是否必选	参数类型	说明
  event_name	是	String	事件名称。 必须以字母开头，只能包含0-9/a-z/A-Z/_，长度最短为1，最大为64。
  event_source	是	String	事件来源。 格式为service.item，根据实际情况自定义配置。 service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_，service.item总长度最短为3，最大为32。
  time	是	Long	事件发生时间。UNIX时间戳，单位毫秒。 说明： 因为客户端到服务器端有延时，因此插入数据的时间戳应该在[当前时间-1小时+20秒，当前时间+10分钟-20秒]区间内，保证到达服务器时不会因为传输时延造成数据不能插入数据库。 例如，当前时间为2020.01.30 12:00:30，则插入时间的时间戳应该在[2020.01.30 11:00:50, 2020.01.30 12:10:10]区间内。对应的Unix时间戳是[1580353250, 1580357410]。
  detail	是	Detail object	事件详情。 详细参数请参见表4。

  表4 detail字段数据结构说明

  名称	是否必选	参数类型	说明
  content	否	String	事件内容，最大长度4096。
  group_id	否	String	所属分组。 资源分组对应的ID，必须是已存在的分组ID。 分组ID查询方法： 登录管理控制台。 单击“云监控服务”。 单击页面左侧的“资源分组”。 在名称/ID列获取具体资源分组ID。
  resource_id	否	String	资源ID，支持字母、数字_ -：，最大长度128。 例如，6a69bf28-ee62-49f3-9785-845dacd799ec。 资源ID的查询方法： 登录管理控制台。 单击“计算 > 弹性云服务器”。 在资源概览页可获取具体资源ID。
  resource_name	否	String	资源名称，支持字母 中文 数字_ -. ，最大长度128。
  event_state	否	String	事件状态。 枚举类型：normal\warning\incident
  event_level	否	String	事件级别。 枚举类型：Critical, Major, Minor, Info
  event_user	否	String	事件用户。 支持字母 数字_ -/空格 ，最大长度64。
  event_type	否	String	事件类型。 枚举类型，EVENT.SYS或EVENT.CUSTOM，EVENT.SYS为系统事件，用户自已不能上报，只能传EVENT.CUSTOM。
  dimensions	否	Array of objects	事件的维度，目前最大支持4个维度，根据维度描述资源信息。 用于指定资源、资源分组的事件告警场景中，支持按维度配置告警规则。 详细参数说明请参见表5。

  表5 dimensions 字段数据结构说明

  名称	类型	是否必选	描述
  name	String	是	监控维度名称，例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表，可参考维度中key字段。
  value	String	是	维度取值，例如弹性云服务器的ID。 长度最短为1，最大为256。

• 请求样例

  [{
      "event_name":"systemInvaded",
      "event_source":"financial.System",
      "time":1522121194000,
      "detail":{
          "content":"The financial system was invaded",
          "group_id":"rg15221211517051YWWkEnVd",
          "resource_id":"1234567890sjgggad",
          "resource_name":"ecs001",
          "event_state":"normal",
          "event_level":"Major",
          "event_user":"xiaokong",
          "event_type": "EVENT.CUSTOM"
      }
  },
  {
      "event_name":"systemInvaded",
      "event_source":"financial.System",
      "time":1522121194020,
      "detail":{
          "content":"The financial system was invaded",
          "group_id":"rg15221211517051YWWkEnVd",
          "resource_id":"1234567890sjgggad",
          "resource_name":"ecs001",
          "event_state":"normal",
          "event_level":"Major",
          "event_user":"xihong",
          "event_type": "EVENT.CUSTOM"
      }
  }]

响应消息

• 响应参数

  表6 参数说明

  名称	参数类型	说明
  数组元素	Array of objects	事件列表。 详细参数请参见表7。

  表7 响应参数

  名称	是否必选	参数类型	说明
  event_id	是	String	事件ID。
  event_name	是	String	事件名称。 必须以字母开头，只能包含0-9/a-z/A-Z/_，长度最短为1，最大为64。

• 响应样例

  [
         {
              "event_id":"evdgiqwgedkkcvhdjcdu346",
              "event_name":"systemInvaded"
          },
          {
              "event_id":"evdgiqwgedkkcvhdjcdu347",
              "event_name":"systemParalysis"
          }
  ]

返回值

• 正常

  201

• 异常

  返回值	说明
  400 Bad Request	请求错误。
  401 Unauthorized	未提供认证信息，或认证信息错误。
  403 Forbidden	请求页面被禁止访问。
  408 Request Timeout	请求超出了服务器的等待时间。
  429 Too Many Requests	当前请求过多。
  500 Internal Server Error	请求未完成，服务异常。
  503 Service Unavailable	系统暂时不可用，请求受限。

错误码

请参考返回错误码说明。