All Products
Document Center

ApsaraDB for MongoDB:UpgradeDBInstanceEngineVersion

Last Updated:Jan 17, 2023

Upgrades the database version of an ApsaraDB for MongoDB instance.

Operation Description

The instance must be in the running state when you call this operation.

  • The available database versions depend on the storage engine used by the instance. For more information, see Upgrades of MongoDB major versions. You can also call the DescribeAvailableEngineVersion operation to query the available database versions.
  • You cannot downgrade the MongoDB version of an instance after you upgrade it.
  • The instance is automatically restarted for two to three times during the upgrade process. Make sure that you upgrade the instance during off-peak hours.
  • Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • 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 keyword: refers to the condition keyword defined by the cloud product itself.
    • 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.
    Operate access level Resource type conditional keyword Association operation
    dds:UpgradeDBInstanceEngineVersion WRITE
    • MongoDB

    Request parameters

    Parameter Type Required Description Example
    DBInstanceId string Yes

    The ID of the instance.

    EngineVersion string Yes

    The database version to which you want to upgrade. Valid values: 3.4, 4.0, and 4.2.

    Note This database version must be later than the current database version of the instance.

    Response parameters

    Parameter Type Description Example
    RequestId string

    The ID of the request.



    Normal return example


      "RequestId": "C4907B00-A208-4E0C-A636-AA85140E406C"

    Error codes

    Http code Error code Error message
    400 EngineVersion.ERROR Target engineVersion must be greater than the current one.

    For a list of error codes, visit the API error center.