文档中心

云数据库 PostgreSQL 版

事件管理

DescribePlannedEvents

DescribePlannedEvents

调用 DescribePlannedEvents 接口查询当前地域下的运维事件。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
InstanceName	String	否	测试实例	实例名称。
InstanceId	String	否	postgres-a2f9831f****	实例 ID。
EventId	String	否	61c7adeb0f49426ab032cb8cf1e2****	事件 ID。
EventType	Array of String	否	["VersionUpgrade"]	事件类型。取值范围（可取多个值）： VersionUpgrade：版本升级。 HostOffline：主机下线。
Status	Array of String	否	["WaitStart"]	运维事件的状态。取值范围（可取多个值）： Canceled：已取消。 WaitStart：待执行。 WaitSwitch：待切换。 Running：运行中。 Running_BeforeSwitch：运行中-切换前。 Running_Switching：运行中-切换中。 Running_AfterSwitch：运行中-切换后。 Success：成功。 Failed：失败。 Timeout：超时。 Rollbacking：回滚中。 RollbackFailed：回滚失败。
PlannedBeginTimeSearchRangeStart	String	否	2025-09-01T02:06:53.000Z	按照“计划执行时间”查询事件时的时间区间的起点。格式：yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
PlannedBeginTimeSearchRangeEnd	String	否	2025-09-01T17:40:53.000Z	按照“计划执行时间”查询事件时的时间区间的终点。格式：yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。说明 PlannedBeginTimeSearchRangeEnd 应晚于 PlannedBeginTimeSearchRangeStart。 PlannedBeginTimeSearchRangeStart 与 PlannedBeginTimeSearchRangeEnd 定义了一个时间段。当事件满足，其“计划执行时间”落入该时间段范围内时，该事件将被检索命中并返回。
PlannedSwitchTimeSearchRangeStart	String	否	2025-09-01T18:17:28.000Z	按照“计划切换时间”查询事件时的时间区间的起点。格式：yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
PlannedSwitchTimeSearchRangeEnd	String	否	2025-09-01T18:47:28.000Z	按照“计划切换时间”查询事件时的时间区间的终点。格式：yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。 PlannedSwitchTimeSearchRangeStart 与 PlannedSwitchTimeSearchRangeEnd 定义了一个时间段。当事件的“计划切换时间段”与该时间段范围有重叠时，该事件将被返回。
PageNumber	Integer	否	2	当前页查询偏移量，默认值为 1。
PageSize	Integer	否	20	每页记录数，取值应大于 0 且不超过 1000，默认值为 10。

返回参数

参数	类型	示例值	描述
Total	Integer	4	运维事件总数。
PlannedEvents	Array of PlannedEvent	请参见返回示例。	当前地域内在当前查询条件下的运维事件列表。

PlannedEvent

参数	类型	示例值	描述
BusinessImpact	String	切换过程会可能有秒级连接闪断，建议程序设置自动重试重连机制以避免事件影响。	运维事件对业务的影响。
EventID	String	61c7adeb0f49426ab032cb8cf1e2ca83	运维事件的 ID。
EventType	String	VersionUpgrade	运维事件的类型。取值范围： VersionUpgrade：版本升级。 HostOffline：主机下线。
InstanceId	String	postgres-a2f9831f****	运维事件相关实例的 ID。
InstanceName	String	测试实例	运维事件相关实例的名称。
MaxDelayTime	String	2025-07-30T20:00:00.000Z	运维事件的最晚可推迟时间。格式：yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
PlannedBeginTime	String	2025-09-01T17:43:09.000Z	运维事件的开始时间。格式：yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
PlannedEventReason	String	实例版本例行升级迭代, 修复已知问题和发布新特性。	发起运维事件的原因。取值为：实例版本例行升级迭代, 修复已知问题和发布新特性。因为实例宿主机硬件老化、异常或者需要对主机模块进行升级处理从而产生的主机运维操作。
PlannedSwitchBeginTime	String	2025-09-01T18:00:23.000Z	运维事件计划切换的开始时间。格式：yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
PlannedSwitchEndTime	String	2025-09-01T18:30:23.000Z	运维事件计划切换的结束时间。格式：yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
Region	String	cn-beijing	地域的 ID。
Status	String	WaitStart	运维事件的状态。取值范围如下： Canceled：已取消。 WaitStart：待执行。 WaitSwitch：待切换。 Running：运行中。 Running_BeforeSwitch：运行中-切换前。 Running_Switching：运行中-切换中。 Running_AfterSwitch：运行中-切换后。 Success：成功。 Failed：失败。 Timeout：超时。 Rollbacking：回滚中。 RollbackFailed：回滚失败。

示例

请求示例

返回示例

最近更新时间：2026.03.31 10:39:12

这个页面对您有帮助吗？

有用

有用

无用

无用