Call the DescribePlannedEvents API to query the operation and maintenance events in the current region.

Request type

Synchronous request.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameter	Type	Required?	Example	Description
InstanceName	String	No	Test instance	Storage type.
InstanceId	String	No	postgres-a2f9831f****	Instance ID.
EventId	String	No	61c7adeb0f49426ab032cb8cf1e2****	Event ID.
EventType	Array of String	No	["VersionUpgrade"]	Event type. Value range (multiple values allowed): VersionUpgrade: version upgrade hHostOffline: Host offline.
Status	Array of String	No	["WaitStart"]	State of operation and maintenance events. Value range (multiple values allowed): Canceled: cancelled. WaitStart: waiting for execution. WaitSwitch: to be switched. Running: running. Running_BeforeSwitch: running - before switching. Running_Switching: running - switching. Running_AfterSwitch: running - after switching. Succeeded: succeeded. Failed: failed. Timeout: timeout. Rollbacking: rolling back. RollbackFailed: failed to rollback.
PlannedBeginTimeSearchRangeStart	String	No	2025-09-01T02:06:53.000Z	Start time of the time range when querying events by planned execution time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
PlannedBeginTimeSearchRangeEnd	String	No	2025-09-01T17:40:53.000Z	End time of the time range when querying events by planned execution time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time). tip PlannedBeginTimeSearchRangeEnd should be later than PlannedBeginTimeSearchRangeStart. PlannedBeginTimeSearchRangeStart and PlannedBeginTimeSearchRangeEnd define a time range. When an event meets the condition that its “planned execution time” falls within this range, the event will be retrieved and returned.
PlannedSwitchTimeSearchRangeStart	String	No	2025-09-01T18:17:28.000Z	Start time of the time range when querying events by scheduled switching time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
PlannedSwitchTimeSearchRangeEnd	String	No	2025-09-01T18:47:28.000Z	End time of the time range when querying events by scheduled switching time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time). PlannedSwitchTimeSearchRangeStart and PlannedSwitchTimeSearchRangeEnd define a time range. When the scheduled switching time period of an event overlaps with the range of the time period, the event will be returned.
PageNumber	Integer	No	2	The query offset of the current page. The default value is 1.
PageSize	Integer	No	20	The number of records on each page. The value must be greater than 0 and no more than 1,000. The default value is 10.

Response parameter

Parameter	Type	Example	Description
Total	Integer	4	Total number of operation and maintenance events.
PlannedEvents	Array of PlannedEvent	Refer to the Sample response.	The list of operation and maintenance events in the current region under the current query conditions.

PlannedEvent

Parameter	Type	Example	Description
BusinessImpact	String	The connection may be broken in seconds during the switching process. It is recommended that the program set an automatic retry and reconnect mechanism to avoid the impact of the event.	Impact of operation and maintenance events on business.
EventID	String	61c7adeb0f49426ab032cb8cf1e2ca83	ID of the operation and maintenance events.
EventType	String	VersionUpgrade	Operation and maintenance event type. Range: VersionUpgrade: version upgrade HostOffline: host offline.
InstanceId	String	postgres-a2f9831f****	ID of the operation and maintenance event instance.
InstanceName	String	Test instance	Name of the operation and maintenance event instance.
MaxDelayTime	String	2025-07-30T20:00:00.000Z	Latest postponed time of operation and maintenance events. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
PlannedBeginTime	String	2025-09-01T17:43:09.000Z	Start time of the operation and maintenance event. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
PlannedEventReason	String	Instance version routine upgrade and iteration, fixing known issues and releasing new features.	Reason for initiating operation and maintenance events. Values are: Instance version routine upgrade and iteration, fixing known issues and releasing new features. Host operation and maintenance is initiated for hardware maintenance on the host machine of the instance due to hardware aging, abnormality, or the need to upgrade the host module.
PlannedSwitchBeginTime	String	2025-09-01T18:00:23.000Z	Start time of operation and maintenance events plan switching. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
PlannedSwitchEndTime	String	2025-09-01T18:30:23.000Z	End time of the scheduled switching for operation and maintenance events. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
Region	String	cn-beijing	Region ID.
Status	String	WaitStart	State of operation and maintenance events. Values are as follows: Canceled: cancelled. WaitStart: waiting for execution. WaitSwitch: to be switched. Running: running. Running_BeforeSwitch: running - before switching. Running_Switching: running - switching. Running_AfterSwitch: running - after switching. Succeeded: succeeded. Failed: failed. Timeout: timeout. Rollbacking: rolling back. RollbackFailed: failed to rollback.

Example

Sample request

Sample response

RDS for PostgreSQL