文档首页/ 云监控服务 CES/ API参考/ API/ 事件监控/ 事件监控/ 查询事件监控列表
更新时间：2025-08-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询事件监控列表

功能介绍

查询事件列表，包括系统事件和自定义事件。

事件子类参数当前只在华东-上海一、华东-上海二、华北-北京四、华南-广州区域上线，其余区域持续上线中。

调试

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

URI

GET /V1.0/{project_id}/events

  • 参数说明
    表1 参数说明

    名称

    类型

    是否必选

    说明

    project_id

    String

    是

    参数解释：

    项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见获取项目ID。

    约束限制：

    不涉及。

    取值范围：

    字符串长度在1 ~64 之间。

    默认取值：

    不涉及。

    event_type

    String

    否

    参数解释：

    事件类型。

    约束限制：

    不涉及。

    取值范围：

    枚举值：EVENT.SYS或EVENT.CUSTOM。

    • EVENT.SYS表示系统事件
    • EVENT.CUSTOM表示自定义事件。

    默认取值：

    不涉及。

    sub_event_type

    String

    否

    参数解释：

    事件子类。

    约束限制：

    不涉及。

    取值范围：

    枚举类型，当事件类型为系统事件时，参数值为SUB_EVENT.OPS或SUB_EVENT.PLAN。SUB_EVENT.OPS为运维事件，SUB_EVENT.PLAN为计划事件。

    当事件类型为自定义事件时，参数值为SUB_EVENT.CUSTOM，表示自定义事件。

    默认取值：

    SUB_EVENT.OPS

    event_name

    String

    否

    参数解释：

    事件名称，值为系统产生的事件名称或用户自定义上报的事件名称

    约束限制：

    不涉及。

    取值范围：

    字符最小长度为1，最大长度为64。

    默认取值：

    不涉及。

    from

    Integer

    否

    参数解释：

    查询数据起始时间，UNIX时间戳，单位毫秒，例如：1605952700911。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    to

    Integer

    否

    参数解释：

    查询数据截止时间，UNIX时间戳，单位毫秒，例如：1606557500911。

    约束限制：

    from必须小于to。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    start

    Integer

    否

    参数解释：

    分页起始值，类型为integer。

    约束限制：

    不涉及。

    取值范围：

    大于等于0

    默认取值：

    0

    limit

    Integer

    否

    参数解释：

    单次查询的条数限制，用于限制结果数据条数。

    约束限制：

    不涉及。

    取值范围：

    取值范围为(0,100]。

    默认取值：

    100
  • 样例 
    GET https://{云监控的endpoint}/V1.0/{project_id}/events

请求消息

无

响应消息

  • 响应参数
表2 参数说明

名称

类型

是否必选

描述

events

Array of Events objects

否

参数解释：

一条或者多条事件数据。

详细参数说明请参见表3。

meta_data

MetaData object

否

参数解释：

查询结果元数据统计个数。

详细参数说明请参见表4。
表3 events字段数据结构说明

名称

类型

是否必选

描述

event_name

String

否

参数解释：

事件名称。

取值范围：

不涉及。

event_type

String

否

参数解释：

事件类型。

取值范围：

不涉及。

sub_event_type

String

否

参数解释：

事件子类。

取值范围：

枚举类型。

  • SUB_EVENT.OPS为运维事件
  • SUB_EVENT.PLAN为计划事件
  • SUB_EVENT.CUSTOM为自定义事件。

event_count

Integer

否

参数解释：

选择查询的时间范围内，此事件发生的数量。

取值范围：

不涉及。

latest_occur_time

Long

否

参数解释：

此事件最近一次发生的时间。

取值范围：

不涉及。

latest_event_source

String

否

参数解释：

事件来源，如果是系统事件则值为各服务的命名空间，可查看支持监控的服务列表。

如果是自定义事件,则为用户自定义上报定义。

取值范围：

不涉及。
表4 meta_data字段数据结构说明

名称

类型

是否必选

描述

total

Integer

否

参数解释：

事件总条数。

取值范围：

不涉及。
  • 响应样例 
    {
 "events": [
   {
     "event_name": "rebootServer",
     "event_type": "EVENT.SYS",
     "sub_event_type": "SUB_EVENT.OPS",
     "event_count": 5,
     "latest_occur_time": 1606302400000,
     "latest_event_source": "SYS.ECS"
   },
   {
     "event_name": "deleteVolume",
     "event_type": "EVENT.SYS",
     "sub_event_type": "SUB_EVENT.OPS",
     "event_count": 6,
     "latest_occur_time": 1606300359126,
     "latest_event_source": "SYS.EVS"
   },
   {
     "event_name": "event_001",
     "event_type": "EVENT.CUSTOM",
     "sub_event_type": "SUB_EVENT.CUSTOM",
     "event_count": 4,
     "latest_occur_time": 1606499035522,
     "latest_event_source": "TEST.System"
   }
 ],
 "meta_data": {
   "total": 10
 }
}

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误。

    401 Unauthorized

    未提供认证信息，或认证信息错误。

    403 Forbidden

    请求页面被禁止访问。

    408 Request Timeout

    请求超出了服务器的等待时间。

    429 Too Many Requests

    当前请求过多。

    500 Internal Server Error

    请求未完成，服务异常。

    503 Service Unavailable

    系统暂时不可用，请求受限。

错误码

请参考返回错误码说明。

父主题： 事件监控

相关文档