# 查询事件监控列表 - ListEvents #### 功能介绍 查询事件监控列表，包括系统事件和自定义事件。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CES/doc?api=ListEvents&version=v1)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ces/ces_03_0045.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ces:events:list | List | - | - | - | - | #### URI GET /V1.0/{project_id}/events 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-ces/ces_03_0057.html)。 **约束限制**: 不涉及。 **取值范围**: 长度为\[1,64\]个字符。 **默认取值**: 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | event_type | 否 | String | **参数解释** 事件类型 **约束限制** 不涉及 **取值范围** 枚举值： - EVENT.SYS 系统事件 - EVENT.CUSTOM 自定义事件 **默认取值** 不涉及 | | sub_event_type | 否 | String | **参数解释** 事件子类型 **约束限制** 不涉及 **取值范围** 枚举值： - SUB_EVENT.OPS 运维事件 - SUB_EVENT.PLAN 计划事件 - SUB_EVENT.CUSTOM 自定义事件 **默认取值** 不涉及 | | event_name | 否 | String | **参数解释** 事件名称，值为系统产生的事件名称，或用户自定义上报的事件名称 **约束限制** 不涉及 **取值范围** 必须以字母（大写或小写）开头，后面可以跟零个或多个字母（大写或小写）、数字、下划线（_），长度为\[1,64\]个字符 **默认取值** 不涉及 | | from | 否 | Long | **参数解释** 查询数据起始时间，UNIX时间戳，单位毫秒 **约束限制** 不涉及 **取值范围** 毫秒级时间戳，范围为\[1111111111111,9999999999999\] **默认取值** 不涉及 | | to | 否 | Long | **参数解释** 查询数据截止时间，UNIX时间戳，单位毫秒 **约束限制** from必须小于to **取值范围** 毫秒级时间戳，范围为\[1111111111111,9999999999999\] **默认取值** 不涉及 | | start | 否 | String | **参数解释** 分页起始值 **约束限制** 不涉及 **取值范围** 非负整数 **默认取值** 0 | | limit | 否 | Integer | **参数解释** 单次查询的条数限制 **约束限制** 不涉及 **取值范围** 条数限制为\[1,100\] **默认取值** 100 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 否 | String | **参数解释**: 发送的实体的MIME类型。 **约束限制**: 不涉及。 **取值范围**: 长度为\[1,64\]个字符。 **默认取值**: 默认使用 application/json; charset=UTF-8，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 | | X-Auth-Token | 否 | String | **参数解释**: 用户Token。 **约束限制**: 不涉及。 **取值范围**: 长度为\[1,16384\]个字符。 **默认取值**: 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | events | Array of [EventInfo] objects | **参数解释** 一条或者多条事件数据 | | meta_data | [TotalMetaData] object | **参数解释**： 查询结果元数据统计个数。 | 表5EventInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | event_name | String | **参数解释** 事件名称 **取值范围** 不涉及 | | event_type | String | **参数解释** 事件类型 **取值范围** 枚举值： - EVENT.SYS 系统事件 - EVENT.CUSTOM 自定义事件 | | sub_event_type | String | **参数解释** 事件子类型 **取值范围** 枚举值： - SUB_EVENT.OPS 运维事件 - SUB_EVENT.PLAN 计划事件 - SUB_EVENT.CUSTOM 自定义事件 | | event_count | Integer | **参数解释** 选择查询的时间范围内，此事件发生的数量 **取值范围** 不涉及 | | latest_occur_time | Long | **参数解释** 此事件最近一次发生的时间 **取值范围** 不涉及 | | latest_event_source | String | **参数解释** 事件来源，如果是系统事件则值为各服务的命名空间。 各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)。如果是自定义事件，则为用户自定义上报定义。 **取值范围** 不涉及 | 表6TotalMetaData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释**： 总条数。 **取值范围**： 在\[0,2147483647\]区间内。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求错误。 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 未提供认证信息，或认证信息错误。 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求页面被禁止访问。 | **状态码：408** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求超出了服务器的等待时间。 | **状态码：429** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求过多。 | **状态码：500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求未完成，服务异常。 | **状态码：503** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 系统暂时不可用，请求受限。 | #### 请求示例 ``` /V1.0/{project_id}/events?start=0&limit=10&to=1606557500911&from=1605952700911 ``` #### 响应示例 **状态码：200** OK ``` { "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.PLAN", "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 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 408 | Request Timeout | | 429 | Too Many Requests | | 500 | Internal Server Error | | 503 | Service Unavailable | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ces/ErrorCode.html)。