All Products
Search
Document Center

ApsaraDB for MongoDB:UpgradeDBInstanceEngineVersion

Last Updated:Jan 16, 2024

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.

Note
  • 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.
  • Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    dds:UpgradeDBInstanceEngineVersionWRITE
    • dbinstance
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      none
    none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the instance.

    dds-bpxxxxxxxx
    EngineVersionstringYes

    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.
    4.0

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    C4907B00-A208-4E0C-A636-AA85140E406C

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError message
    400EngineVersion.ERRORTarget engineVersion must be greater than the current one.

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

    Change history

    Change timeSummary of changesOperation
    2024-01-09The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400