# 查询事件列表 - ListScheduleEvents #### 功能介绍 查询事件列表。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/RDS/doc?api=ListScheduleEvents)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:event:list | list | - | - | - | - | #### URI - URI格式 GET /v3/{project_id}/schedule-events - 参数说明 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | id | 否 | String | **参数解释：** 事件ID。 如需查询指定事件信息，可[登录RDS管理控制台](https://console.huaweicloud.com/rds/#/rds/management/list)，在左侧导航栏选择"事件管理"，获取事件ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不传该参数，表示查询全部事件信息。 | | instance_id | 否 | String | **参数解释：** 实例ID。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | status | 否 | String | **参数解释：** 事件状态。 **约束限制：** 不涉及。 **取值范围：** - WAITING：等待中。 - INQUIRING：待授权。 - SCHEDULED：待执行。 - EXECUTING：执行中。 - COMPLETED：已完成。 - FAILED：失败。 - CANCELED：已取消。 **默认取值** **：** 为空，表示查询全部状态。 | | type | 否 | String | **参数解释：** 事件类型。 **约束限制：** 不涉及。 **取值范围：** RESTAT_NODE：重启实例节点。 **默认取值** **：** 为空，表示查询全部类型。 | | level | 否 | String | **参数解释：** 事件级别。 **约束限制：** 不涉及。 **取值范围：** - CRITICAL：紧急。 - MAJOR：重要。 - MINOR：一般。 - INFO：提示。 **默认取值** **：** 为空，表示查询全部级别。 | | sort_field | 否 | String | **参数解释：** 排序字段。 **约束限制：** 不涉及。 **取值范围：** - planned_execution_time：计划执行时间。 - created_time：执行时间。 - latest_execution_time：最近执行时间。 **默认取值** **：** 为空，表示不排序。 | | order | 否 | String | **参数解释：** 排序顺序。 **约束限制：** 不涉及。 **取值范围：** - DESC：降序。 - ASC：升序。 **默认取值** **：** DESC | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不涉及。 **取值范围：** 大于等于0。 **默认取值** **：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | Integer | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** \[1, 100\] **默认取值** **：** 10 | #### 请求消息 无。 #### 请求示例 查询事件列表。 ``` GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/schedule-events?id=67323a8c-75aa-4d81-941e-02621ccd4d07&instance_id=6970e9cf7adc41a78e0f1f50215c9d3bin03&status=INQUIRING&type=RESTAT_NODE&offset=0&limit=50 ``` #### 响应消息 - 正常响应要素说明 表2响应Body参数 | 名称 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释**： 事件总数。 **取值范围**： 不涉及。 | | inquiring_count | Integer | **参数解释**： 待授权的事件数。 **取值范围**： 不涉及。 | | schedule_count | Integer | **参数解释**： 待执行的事件数。 **取值范围**： 不涉及。 | | executing_count | Integer | **参数解释**： 正在执行的事件数。 **取值范围**： 不涉及。 | | failed_count | Integer | **参数解释**： 执行失败的事件数。 **取值范围**： 不涉及。 | | events | Array of objects | **参数解释**： 事件详情列表，详见[表3]。 | 表3events字段说明 | 名称 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 事件ID。 **取值范围**： 不涉及。 | | instance_id | String | **参数解释**： 实例ID。 **取值范围**： 不涉及。 | | instance_name | String | **参数解释**： 实例名称。 **取值范围**： 不涉及。 | | db_type | String | **参数解释**： 数据库类型。 **取值范围**： - mysql - postgresql - sqlserver | | created_time | String | **参数解释**： 事件创建的时间。 **取值范围**： 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 | | update_time | String | **参数解释**： 事件更新的时间。 **取值范围**： 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 | | type | String | **参数解释**： 事件类型。 **取值范围**： RESTAT_NODE：重启实例节点。 | | impact | String | **参数解释**： 事件对系统的影响。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 事件状态。 **取值范围**： - WAITING：等待中。 - INQUIRING：待授权。 - SCHEDULED：待执行。 - EXECUTING：执行中。 - COMPLETED：已完成。 - FAILED：失败。 - CANCELED：已取消。 | | reason | String | **参数解释**： 事件发生的原因。 **取值范围**： 不涉及。 | | level | String | **参数解释**： 事件的严重级别。 **取值范围**： - CRITICAL：紧急。 - MAJOR：重要。 - MINOR：一般。 - INFO：提示。 | | execute_time | String | **参数解释**： 事件执行的时间。 **取值范围**： 不涉及。 | | latest_execution_time | String | **参数解释**： 事件最近一次执行的时间。 **取值范围**： 不涉及。 | | execution_time_window | Array of objects | **参数解释**： 事件执行的时间窗，详见[表4]。 | 表4execution_time_window字段说明 | 名称 | 参数类型 | 描述 | |:---|:---|:---| | planned_execution_day | String | **参数解释**： 事件执行时间窗所在的日期。 **取值范围**： 不涉及。 | | start_time | String | **参数解释**： 事件执行时间窗的开始时间。 **取值范围**： 格式为HH:mm，为UTC时间。 | | end_time | String | **参数解释**： 事件执行时间窗的结束时间。 **取值范围**： 格式为HH:mm，为UTC时间。 | - 正常响应样例 ``` { "total_count": 1, "inquiring_count": 1, "schedule_count": 0, "executing_count": 0, "failed_count": 0, "events": [ { "id": "created_time", "instance_name": "TestInstance", "db_type": "postgresql", "created_time": "2024-06-30T09:04:35+0800", "update_time": "2024-06-30T09:04:35+0800", "type": "RESTAT_NODE", "impact": "Instance Intermittent Disconnection", "status": "INQUIRING", "reason": "ECS_RESTART", "level": "MAJOR", "execute_time": "", "latest_execution_time": "", "execution_time_window": [{ "planned_execution_day": "2026-02-14", "start_time": "02:00", "end_time": "06:00" }] } ] } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。