All Products
Search

This Product

    ApsaraDB for MongoDB:ModifyDBInstanceDiskType

    Document Center

    ApsaraDB for MongoDB:ModifyDBInstanceDiskType

    Last Updated:Nov 21, 2025

    Modifies the disk type of an ApsaraDB for MongoDB instance.

    Operation description

    • This feature is not supported for instances with less than 40 GB of disk space.

    • You can change the disk type only to an ESSD AutoPL disk (cloud_auto).

    • The interval between two consecutive modifications to the provisioned input/output operations per second (IOPS) of an instance must be longer than one hour. For more information, see Modify the performance of an ESSD AutoPL disk.

    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:ModifyDBInstanceDiskType

    update

    *Instance

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

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    DbInstanceStorageType

    string

    No

    The disk type after the modification. Valid value:

    • cloud_auto: ESSD AutoPL disk.

    cloud_auto

    ProvisionedIops

    integer

    No

    The provisioned IOPS. Valid values: 0 to 50000.

    1960

    DBInstanceId

    string

    Yes

    The instance ID.

    dds-bp1fa5efaa93****

    AutoPay

    boolean

    No

    Specifies whether to enable automatic payment. Valid values:

    • true: Enables automatic payment. Make sure that your account has a sufficient balance.

    • false: Disables automatic payment. 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.

    Default value: true.

    true

    BusinessInfo

    string

    No

    The business information. This is an additional parameter.

    {“ActivityId":"000000000"}

    CouponNo

    string

    No

    The coupon code. The default value is youhuiquan_promotion_option_id_for_blank.

    youhuiquan_promotion_option_id_for_blank

    ExtraParam

    string

    No

    An additional parameter.

    async

    AutoRenew

    string

    No

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

    • true: Enables auto-renewal.

    • false: Disables auto-renewal.

    Default value: false

    false

    OrderType

    string

    No

    The order type. Valid values:

    • UPGRADE: Upgrades the instance configuration.

    • DOWNGRADE: Downgrades the instance configuration.

    Note

    This parameter is available only when the instance uses the subscription billing method.

    UPGRADE

    Response elements

    Parameter

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    D8F1D721-6439-4257-A89C-F1E8E9C9****

    OrderId

    string

    The order ID.

    21012719476****

    Examples

    Success response

    JSON format

    {
  "RequestId": "D8F1D721-6439-4257-A89C-F1E8E9C9****",
  "OrderId": "21012719476****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.