View and manage scheduled events for ApsaraDB for MongoDB - ApsaraDB for MongoDB

In addition to notifications delivered by phone calls, emails, or internal messages, ApsaraDB for MongoDB also sends notifications for scheduled O&M events, such as instance migrations and version upgrades, in the console. You can view event details, such as the type, cause, and business impact, and manually modify the switchover time.

Prerequisites

An ApsaraDB for MongoDB instance with a scheduled event.

Note

You can view the number of pending events in the Scheduled Events notification at the top of the ApsaraDB for MongoDB console.

Notes

Events are classified into two levels of urgency:
- [S0 Urgent] Risk Remediation: Typically involves unexpected issues requiring immediate action to prevent service failures. Notifications for these events are sent three days or less in advance, and the window for rescheduling the switchover time is shorter. Examples include urgent version replacement and upgrades, host failure recovery, and upgrades for expiring SSL certificates.
- [S1 Scheduled] System Maintenance: Involves low-risk issue fixes or planned software and hardware upgrades. Notifications for these events are usually sent more than three days in advance, and you can cancel the event.
To receive notifications for scheduled O&M events, log on to the Message Center, and select the notification methods and configure contacts for ApsaraDB Fault or Maintenance Notifications. We recommend adding your database O&M personnel as contacts. Otherwise, you will not receive event notifications.Notification methods include Email and Internal Messages. We recommend you select Email to ensure delivery.

In the upper-right corner of the console, click the bell icon. Then, in the Internal Message Notifications panel, click Message Settings.

Figure 1. Accessing Message Settings

Figure 2. Notification settings for ApsaraDB

To receive real-time updates on O&M events or implement custom, event-driven automation, configure system event subscriptions in CloudMonitor. ApsaraDB pushes system events to CloudMonitor for each stage of the O&M event lifecycle, such as Scheduled, In Progress, Succeeded, and Canceled. For more information, see Manage event subscriptions (Recommended). For a list of subscribable CloudMonitor events, see Appendix 1: CloudMonitor-related system events.

Expand to view a sample CloudMonitor event.

{
  "eventId": "c864b30b-7f69-5f04-b0e7-8dfb0eabcfd9", // A unique ID for the event.
  "product": "RDS",                                  // The service code.
  "reason": "Host software/hardware upgrade",        // The reason for the event.
  "extra": {
    "impactEn": "Transient instance disconnection",  // The impact of the event.
    "eventCode": "rds_apsaradb_transfer",            // The code for the O&M event type.
    "eventNameEn": "Instance migration",             // The name of the O&M event.
    "switchTime": "2024-09-15T01:30:00+08:00",       // The scheduled switchover time. A transient instance disconnection may occur at this time.
    "startTime": "2024-09-14T21:30:00+08:00",          // The time when the event is queued for execution.
    "cancelCode": "OutOfGoodPerfBySoftHardwareUpgrade", // The cancellation risk code. For details, see Appendix 2: Detailed cause codes and cancellation risks.
    "detailCode": "HostSoftHardwareUpgrade",            // The detailed cause code. For details, see Appendix 2: Detailed cause codes and cancellation risks.
    "instanceInfo": ""
  },
  "instanceId": "rm-2ze9d66o65q1g02g6",             // The instance ID.
  "eventType": "Maintenance",
  "instanceComment": "rm-2ze9d66o65q1g02g6",        // The alias of the instance.
  "instanceType": "Instance",
  "publishTime": "2024-09-10T16:01:47+08:00"
}

Procedure

Log on to the ApsaraDB for MongoDB console.
In the left-side navigation pane, click Event Center.
Important
For O&M events that require you to schedule a switchover time, a pop-up window prompts you to schedule the time.

On the Scheduled Events page, perform the required operations.

View event details
In the Scheduled Events list, you can view information about the target instance, such as Event type, Cause, Business impact, Start Time, Scheduled Switching Time, Latest Execution Time, Status, Database type, and Cancelable. For more information about the causes and impacts of events, see Causes and impacts of events.

Configure the switchover time

You can set the switchover time for a scheduled event in one of the following ways: setting a scheduled switchover time, setting a periodic switchover time, or using the instance's maintenance window. The execution priority is as follows: scheduled switchover time > periodic switchover time > instance maintenance window.

Switchover method	Actions
Scheduled switchover time	In the Scheduled Events list, select one or more events. In the upper-left corner of the Scheduled Events list, click Schedule Event. In the Schedule Event panel, set the scheduled switchover time. Note You can select the Set earliest execution time checkbox. The system automatically fills in the earliest possible switchover date and time. After you confirm, the instance starts preparing for the switchover and enters the pending state. If you clear this checkbox, you can customize the switchover date and time. The Scheduled Switching Time cannot be later than the Latest Execution Time. Confirm that you have selected the correct events. If the events are correct, click Save. If the selected events are incorrect, go back to the Scheduled Events list, select the correct events, and then reset the scheduled switchover time.
Periodic switchover time	Important After a periodic switchover time is set, the system performs the switchover for any newly generated scheduled events during the next time slot. For example, if the periodic switchover time is set to 12:00:00 on Tuesday and 12:00:00 on Friday, the system performs the switchover at 12:00:00 on Friday for any scheduled events generated between 12:00:00 on Tuesday and 12:00:00 on Friday. For events generated after 12:00:00 on Friday, the switchover occurs at 12:00:00 on the following Tuesday. In the upper-left corner of the Scheduled Events list, click Global Scheduler. In the Global Scheduler panel, set a periodic switchover time by week(s) or Month based on your business needs. Note You can view the configured periodic switchover time in the upper-right corner of the Scheduled Events list. If the periodic switchover time is set to None, it is not displayed. Click Save.
Instance maintenance window	The default maintenance window is 02:00-06:00. You can click the instance ID for an event and view the maintenance window in the Specification Information section on the Basic Information page. You can also click Edit next to Maintenance Window to change it. For more information, see Set a maintenance window.

Cancel a scheduled event
If the Event type is Update Minor Version, you can click Cancel Scheduled Event in the upper-left corner of the Scheduled Events list.

Causes and impacts of events

Cause	Business impact	Description
Instance migration	Transient disconnection	Once the scheduled switchover begins, the following impacts occur: During the switchover, your instance or its shards will be read-only and experience a transient disconnection for up to 30 seconds while data synchronizes. We recommend performing the switchover during off-peak hours and ensure that your application has a reconnection mechanism. Use of the instance with DMS and DTS is briefly affected. Service resumes automatically after the operation is complete.
Minor version upgrade	Transient disconnection	Once the scheduled switchover begins, the following impacts occur: During the switchover, your instance or its shards will be read-only and experience a transient disconnection for up to 30 seconds while data synchronizes. We recommend performing the switchover during off-peak hours and ensure that your application has a reconnection mechanism. Use of the instance with DMS and DTS is briefly affected. Service resumes automatically after the operation is complete.
Minor version upgrade	Minor version update	The updates vary between minor versions (engine versions). You should review the differences between the upgraded version and the current version.
Proxy minor version upgrade	Transient disconnection	Once the scheduled switchover begins, the following impacts occur: During the switchover, your instance or its shards will be read-only and experience a transient disconnection for up to 30 seconds while data synchronizes. We recommend performing the switchover during off-peak hours and ensure that your application has a reconnection mechanism. Use of the instance with DMS and DTS is briefly affected. Service resumes automatically after the operation is complete.
Proxy minor version upgrade	Minor version update	The updates vary between minor versions. You should review the differences between the upgraded version and the current version.
SSL certificate update	Transient disconnection	Once the scheduled switchover begins, the following impacts occur: During the switchover, your instance or its shards will be read-only and experience a transient disconnection for up to 30 seconds while data synchronizes. We recommend performing the switchover during off-peak hours and ensure that your application has a reconnection mechanism. Use of the instance with DMS and DTS is briefly affected. Service resumes automatically after the operation is complete.
Major version upgrade	Transient disconnection	Once the scheduled switchover begins, the following impacts occur: During the switchover, your instance or its shards will be read-only and experience a transient disconnection for up to 30 seconds while data synchronizes. We recommend performing the switchover during off-peak hours and ensure that your application has a reconnection mechanism. Use of the instance with DMS and DTS is briefly affected. Service resumes automatically after the operation is complete.
Major version upgrade	Major version update	The updates vary between major versions (engine versions). You should review the differences between the upgraded version and the current version.

Related APIs

API	Description
DescribeActiveOperationTaskCount	Queries the number of O&M tasks for an ApsaraDB for MongoDB instance.