UpgradeDBInstanceKernelVersion - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Upgrades the minor version of an ApsaraDB for MongoDB instance.

Operation description

When you call the UpgradeDBInstanceKernelVersion operation, the instance must be in the Running state.

Note

The UpgradeDBInstanceKernelVersion operation is applicable to replica set and sharded cluster instances, but not to standalone instances.

The instance will be restarted once during the upgrade. Call this operation during off-peak hours.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dds:UpgradeDBInstanceKernelVersion	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance.	dds-bp2235****
SwitchMode	string	No	The time when to perform the upgrade. Valid values: 0: immediately performs the upgrade. 1: performs the upgrade during the maintenance window.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	27B9A130-7C4B-40D9-84E8-2FC081097AAC

Examples

Sample success responses

JSONformat

{
  "RequestId": "27B9A130-7C4B-40D9-84E8-2FC081097AAC"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-22	The request parameters of the API has changed	View Change Details