All Products
Search

This Product

    ApsaraDB for MongoDB:ModifyDBInstanceSpec

    Document Center

    ApsaraDB for MongoDB:ModifyDBInstanceSpec

    Last Updated:Dec 16, 2025

    Changes the instance type or storage capacity of an ApsaraDB for MongoDB standalone instance, replica set instance, or Serverless instance. Serverless instances are available only on the Alibaba Cloud China Website (www.aliyun.com).

    Operation description

    Before you call this operation, make sure that you understand the billing methods 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 operation.

    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 standalone and replica set instances, 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 Serverless instances, this parameter specifies the computing capacity. Valid values: 100 to 8000.

    Note

    Specify at least one of this parameter and the DBInstanceStorage parameter.

    dds.sn4.xlarge.1
    DBInstanceStorage

    string

    No

    The storage capacity of the instance. The value must be in the range of 10 GB to 3,000 GB. The step size is 10 GB. The specific value is constrained by the instance type. For more information, see Instance types.

    Note

    • Specify at least one of this parameter and the DBInstanceClass parameter.

    • You cannot decrease the storage space.

    50
    OrderType

    string

    No

    The type of configuration change. Valid values:

    • UPGRADE: Upgrades the instance configurations. This is the default value.

    • DOWNGRADE: Downgrades the instance configurations.

    Note

    This parameter is available only for subscription instances.

    UPGRADE
    AutoPay

    boolean

    No

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

    • true: Auto-payment is enabled. This is the default value. Ensure that your account has a sufficient balance.

    • false: Manual payment is required. To pay for the order, log on to the ApsaraDB for MongoDB console. In the upper-right corner of the page, choose Expenses > Expenses and Costs. In the navigation pane on the left, click Order Management. 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. The default value is 3.

    • For a replica set instance, valid values are 3, 5, and 7.

    • For a standalone instance, the value is fixed at 1.

    • For a replica set instance that uses shared storage (available only on the Alibaba Cloud China website (www.aliyun.com)), the value is fixed at 2.

    Note

    Do not configure this parameter for Serverless instances. Serverless instances are available only on the Alibaba Cloud China website (www.aliyun.com).

    3
    ReadonlyReplicas

    string

    No

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

    If the instance is connected only using a classic network and a virtual private cloud (VPC), enable an internet endpoint or release the classic network endpoint before changing the number of read-only nodes.

    Note

    Log on to the ApsaraDB for MongoDB console and view the enabled network types on the Database Connection page.

    1
    CouponNo

    string

    No

    Specifies whether to use a coupon. Valid values:

    • default or null: Uses a coupon. This is the default value.

    • youhuiquan_promotion_option_id_for_blank: Does not use a coupon.

    default
    EffectiveTime

    string

    No

    The time when the configuration change takes effect. Valid values:

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

    • MaintainTime: The change takes effect during the O&M window of the instance.

    Immediately
    ExtraParam

    string

    No

    An additional parameter. Valid values:

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

    • sync: The result is returned after the instance specifications are changed.

    Valid values:

    • async :

      async

    • sync :

      sync

    async
    TargetZoneId

    string

    No

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

    Important This parameter is valid only for cloud disk instances.
    Important The value of this parameter cannot be the same as the value of the `TargetSecondaryZoneId` or `TargetHiddenZoneId` parameter.

    Note

    • This parameter is required only when you change instance specifications and migrate the instance across zones.

    • The destination zone must be in the same region as the current zone of the instance.

    • Call the DescribeRegions operation to query zone IDs.

    cn-hangzhou-j
    TargetSecondaryZoneId

    string

    No

    The destination zone of the secondary node. Specify this parameter when you change the instance specifications and migrate the instance across zones.

    Important This parameter is valid only for cloud disk instances.
    Important The value of this parameter cannot be the same as the value of the `TargetZoneId` or `TargetHiddenZoneId` parameter.

    Note

    • This parameter is required only when you change instance specifications and migrate the instance across zones.

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

    • The destination zone must be in the same region as the current zone of the instance.

    • Call the DescribeRegions operation to query zone IDs.

    cn-hangzhou-h
    TargetHiddenZoneId

    string

    No

    The destination zone of the hidden node. Specify this parameter when you change the instance specifications and migrate the instance across zones.

    Important This parameter is valid only for cloud disk instances.
    Important The value of this parameter cannot be the same as the value of the `TargetZoneId` or `TargetSecondaryZoneId` parameter.

    Note

    • This parameter is required only when you change instance specifications and migrate the instance across zones.

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

    • The destination zone must be in the same region as the current zone of the instance.

    • Call the DescribeRegions operation to query zone IDs.

    cn-hangzhou-i
    TargetVswitchId

    string

    No

    The ID of the destination vSwitch. Specify this parameter when you change the instance specifications and migrate the instance across zones.

    Important This parameter is valid only for cloud disk instances.

    Note

    • This parameter is required only when you change instance specifications and migrate the instance across zones.

    vsw-bp1buy0h9myt5i9e7****

    SearchNodeClass

    string

    No

    The specifications of the Search node.

    mdb.shard.2x.xlarge.d
    SearchNodeStorage

    integer

    No

    The storage capacity of the Search node.

    20
    SearchNodeCount

    integer

    No

    The number of Search nodes.

    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.