When you perform tasks such as creating, upgrading, downgrading, or restarting an instance, you can view the progress and details of these tasks in the Task Center of the MongoDB console.
Procedure
Go to the Task Center page and select a region at the top of the page.
View task information.
You can also filter tasks by start time, keyword, and status.
Supported task types
Task Center supports the following task types.
Disk version
Task name | TaskType (API status) | Architecture | Description |
Create instance | CreateIns | ReplicaSet Sharded cluster | Creates an instance. |
Restart instance | RestartIns | ReplicaSet Sharded cluster | Restarts an instance. |
Primary/secondary failover | HaSwitch | ReplicaSet Sharded cluster | Performs a primary/secondary failover or a role switch for an instance. |
Kernel version upgrade | KernelVersionUpgrade | ReplicaSet Sharded cluster | Performs a major or minor version upgrade for an instance. |
Specification change or migration | ModifyInsSpec | ReplicaSet Sharded cluster | Changes the storage class, upgrades or downgrades the instance, or scales out the instance. |
Network change | ModifyNetwork | ReplicaSet Sharded cluster | Changes the VPC and vSwitch. |
Add node | AddInsNode | ReplicaSet | Adds a node to a replica set instance. |
Sharded cluster | Adds a read-only node to a shard. | ||
Delete node | DeleteInsNode | ReplicaSet | Deletes a node from a replica set instance. |
Sharded cluster | Deletes a read-only node from a shard. | ||
Data flashback | FlashBackIns | ReplicaSet Sharded cluster | Performs a data flashback by key. |
Data restoration | RestoreIns | ReplicaSet Sharded cluster | Performs data restoration by key. |
Add shard | AddInsShards | Sharded cluster | Adds a shard to a sharded cluster instance. |
Delete shard | DeleteInsShards | Sharded cluster | Deletes a shard from a sharded cluster instance. |
Clone instance | CloneIns | ReplicaSet Sharded cluster | Restores data from a backup set, performs a point-in-time restore, or recreates an instance from the recycle bin. |
Delete instance | DeleteIns | ReplicaSet Sharded cluster | Deletes an instance. |
Local disk version
Task name | TaskType (API status) | Architecture | Description |
Create instance | CreateIns | ReplicaSet Sharded cluster | Creates an instance. |
Delete instance | DeleteIns | ReplicaSet Sharded cluster | Deletes an instance. |
Parameter adjustment | ChangeVariable | ReplicaSet Sharded cluster | Modifies kernel parameters, modifies SSL settings, enables transparent data encryption (TDE), or refreshes the audit log configuration for a replica set instance. |
Configuration change | ModifyInsConfig | ReplicaSet | Changes the configuration. |
Restart instance | RestartIns | ReplicaSet Sharded cluster | Restarts an instance. For a sharded cluster instance, restarts the mongos, shard, or Configserver node. |
Primary/secondary failover | HaSwitch | ReplicaSet Sharded cluster | Performs a primary/secondary failover for a replica set instance. For a sharded cluster instance, performs a primary/secondary failover for a shard or Configserver node. |
Kernel version upgrade | KernelVersionUpgrade | ReplicaSet Sharded cluster | Performs a major or minor version upgrade. |
Account change | ModifyAccount | ReplicaSet Sharded cluster | Resets the password. |
Specification change or migration | ModifyInsSpec | ReplicaSet | Scales out the local disk or upgrades/downgrades the instance. |
Sharded cluster | Upgrades or downgrades the mongos, Configserver, or shard node. Changes the instance type of the mongos, Configserver, or shard node. Migrates the instance to another zone. Deletes a read-only node from a shard. | ||
Network change | ModifyNetwork | ReplicaSet | Changes the network settings, including changing routing information and replacing the virtual IP address (VIP). |
Sharded cluster | Changes the network settings, including changes to the VPC, Internet, and classic network. | ||
Lock instance | LockIns | ReplicaSet Sharded cluster | Locks an instance. |
Unlock instance | UnlockIns | ReplicaSet Sharded cluster | Unlocks an instance. |
Add node | AddInsNode | ReplicaSet | Adds a node to a replica set instance. |
Sharded cluster | Adds a read-only node to a shard of a sharded cluster instance. | ||
Delete node | DeleteInsNode | ReplicaSet | Deletes a node from a replica set instance. |
Add shard | AddInsShards | Sharded cluster | Adds one or more shards to a sharded cluster instance. |
Delete shard | DeleteInsShards | Sharded cluster | Deletes a shard from a sharded cluster instance. |
Clone instance | CloneIns | ReplicaSet Sharded cluster | Restores data from a backup set, performs a point-in-time restore, or recreates an instance from the recycle bin. |
Switchover time description
When you create a maintenance task that involves a switchover, such as an instance upgrade, instance downgrade, version upgrade, or restart, note the following:
If you select Execute Immediately, the switchover is performed immediately after the preparations are complete.
If you select Execute Within Maintenance Window (Recommended), preparations are performed first. The switchover is then performed within the specified maintenance window.
To perform the switchover outside the maintenance window or at a specific time, wait until the task status changes to Pending Schedule. Then, when you are ready to perform the switchover, click Modify Switching time in the Actions column of the task list and select Execute now.
FAQ
Related API operations
API operation | Description |
Queries the information about tasks in the Task Center. |