All Products
Search

This Product

    ApsaraDB for MongoDB:ModifyDBInstanceSpec

    Document Center

    ApsaraDB for MongoDB:ModifyDBInstanceSpec

    Last Updated:Apr 14, 2026

    Changes the instance type or storage space for ApsaraDB for MongoDB standalone, replica set, or serverless instances. Serverless instances are exclusive to the Alibaba Cloud China website.

    Operation description

    Before calling this operation, make sure you understand the billing method and pricing of ApsaraDB for MongoDB.

    This operation applies only to ApsaraDB for MongoDB standalone instances and replica set instances. To change the configuration of a sharded cluster instance, call the ModifyNodeSpec, CreateNode, DeleteNode, or ModifyNodeSpecBatch operations.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dds:ModifyDBInstanceSpec

    update

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBInstanceId

    string

    Yes

    The instance ID.

    dds-bp1ea17b41ab****
    DBInstanceClass

    string

    No

    The instance type. For more information, see Instance types. You can also call the DescribeAvailableResource operation to query instance types.

    • For a standalone instance or a replica set instance, this parameter specifies the instance type. For more information, see Instance types. You can also call the DescribeAvailableResource operation to query the instance types of standalone and replica set instances.

    • For a serverless instance, this parameter specifies the computing capacity of the instance. Valid values: 100 to 8000.

    Note

    You must configure one of the DBInstanceStorage and DBInstanceClass parameters.

    dds.sn4.xlarge.1
    DBInstanceStorage

    string

    No

    The storage capacity of the instance. The value must be an integer that is greater than or equal to 10. The value increases in increments of 10. Unit: GB. The values that can be specified for this parameter are subject to the instance type. For more information, see Instance types.

    Note

    • You must configure one of the DBInstanceClass and DBInstanceStorage parameters.

    • You cannot decrease the storage capacity of an instance.

    50
    OrderType

    string

    No

    The specification change type. Valid values:

    • UPGRADE: upgrades the specifications. This is the default value.

    • DOWNGRADE: downgrades the specifications.

    Note

    This parameter is available only for subscription instances.

    UPGRADE
    AutoPay

    boolean

    No

    Specifies whether to enable automatic payment for the instance. Valid values:

    • true: enables automatic payment. Make sure that your account has a sufficient balance. This is the default value.

    • false: disables automatic payment. You can log on to the ApsaraDB for MongoDB console to pay for the instance. In the upper-right corner of the page, choose Billing Management > Billing Management. In the left-side navigation pane, click Orders. On the Product Orders page, find the order and complete the payment.

    true
    BusinessInfo

    string

    No

    The business information.

    {“ActivityId":"000000000"}
    ReplicationFactor

    string

    No

    The number of nodes in the instance. Default value: 3.

    • Valid values for replica set instances: 3, 5, and 7.

    • The value for standalone instances is fixed at 1.

    • The value for replica set instances with shared storage (available only in the China site) is fixed at 2.

    Note

    This parameter is not required for serverless instances (available only in the China site).

    3
    ReadonlyReplicas

    string

    No

    The number of read-only nodes. Valid values: 0 to 5.

    If the network type of the instance is set to only classic network and VPC, you need to enable public access or release the classic network endpoint before you can change the number of read-only nodes.

    Note

    You can log on to the ApsaraDB for MongoDB console and go to the Database Connections page to view the network types that have been enabled.

    1
    CouponNo

    string

    No

    Specifies whether to use a coupon. Valid values:

    • default or null (default): A coupon is used.

    • youhuiquan_promotion_option_id_for_blank: No coupon is used.

    default
    EffectiveTime

    string

    No

    The effective time of the configuration change. Valid values:

    • Immediately: The configuration change immediately takes effect. This is the default value.

    • MaintainTime: The configuration change takes effect during the maintenance window of the instance.

    Immediately
    ExtraParam

    string

    No

    Additional parameters. Valid values:

    • async: The result is returned after the specification change order is created.

    • sync: The result is returned after the instance specification change is delivered.

    Valid values:

    • async :

      async

    • sync :

      sync

    async
    TargetZoneId

    string

    No

    The destination zone to which you want to migrate the instance when you change the specifications and migrate the instance across zones.

    Important This parameter applies only to cloud disk instances.
    Important The value of this parameter cannot be the same as the value of the TargetSecondaryZoneId or TargetHiddenZoneId parameter.

    Note

    • You must specify this parameter only when you change the specifications and migrate the instance across zones.

    • The destination zone and the current zone must be in the same region.

    • You can call the DescribeRegions operation to query zone IDs.

    cn-hangzhou-j
    TargetSecondaryZoneId

    string

    No

    The destination secondary zone for the secondary node when you change the specifications and migrate the instance across zones.

    Important This parameter applies only to cloud disk instances.
    Important The value of this parameter cannot be the same as the value of the TargetZoneId or TargetHiddenZoneId parameter.

    Note

    • You must specify this parameter only when you change the specifications and migrate the instance across zones.

    • This parameter is available only for multi-zone migration.

    • The destination zone and the current zone must be in the same region.

    • You can call the DescribeRegions operation to query zone IDs.

    cn-hangzhou-h
    TargetHiddenZoneId

    string

    No

    The destination zone for the hidden node when you change the specifications and migrate the instance across zones.

    Important This parameter applies only to cloud disk instances.
    Important The value of this parameter cannot be the same as the value of the TargetZoneId or TargetSecondaryZoneId parameter.

    Note

    • You must specify this parameter only when you change the specifications and migrate the instance across zones.

    • This parameter is available only for multi-zone migration.

    • The destination zone and the current zone must be in the same region.

    • You can call the DescribeRegions operation to query zone IDs.

    cn-hangzhou-i
    TargetVswitchId

    string

    No

    The destination vSwitch ID when you change the specifications and migrate the instance across zones.

    Important This parameter applies only to cloud disk instances.

    Note

    • You must specify this parameter only when you change the specifications and migrate the instance across zones.

    vsw-bp1buy0h9myt5i9e7****

    SearchNodeClass

    string

    No

    The specifications of the Search node to be changed.

    mdb.shard.2x.xlarge.d
    SearchNodeStorage

    integer

    No

    The capacity of the Search node to be changed.

    20
    SearchNodeCount

    integer

    No

    The number of Search nodes to be changed.

    2

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    1E9F1104-19E7-59F0-AB7F-F4EBFDEA****
    OrderId

    string

    The order ID.

    21012408824****

    Examples

    Success response

    JSON format

    {
  "RequestId": "1E9F1104-19E7-59F0-AB7F-F4EBFDEA****",
  "OrderId": "21012408824****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 MissingParameter The input parameters DBInstanceClass and DBInstanceStorage all blank or no change.
    400 InvalidDBInstanceClass.ValueNotSupported The specified parameter DBInstanceClass is not valid.
    400 InvalidDBInstanceStorage.ValueNotSupported The specified parameter DBInstanceStorage is not valid.
    400 LX_REQUEST_TOKEN_CONFLICT The request token is conflict.
    400 TradeConfirmPayError BIZ_ERROR - degrade refund error
    400 PRICE.ORIGIN_PRICE_ERROR Origin lingxiao price request error.
    400 ErrorInsufficientResource There is not enough resource for your operation, requestId: %s. There is not enough resource for your operation, requestId: %s.
    403 OperationDenied The resource is out of usage.
    403 InvaildDBInstanceClassInRegion.NotAvailable The DBInstanceClass in the Region is not available.
    404 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in our records.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.