All Products
Search

This Product

    AnalyticDB:MigrateDBCluster

    Document Center

    AnalyticDB:MigrateDBCluster

    Last Updated:Jan 14, 2026

    Migrates a Data Warehouse Edition cluster to a Data Lakehouse Edition or an Enterprise Edition cluster.

    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

    adb:MigrateDBCluster

    update

    *DBCluster

    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The ID of the Data Warehouse Edition cluster.

    am-bp1xxxxxxxx47
    ComputeResource

    string

    No

    The reserved computing resources. Valid values: 0 ACU to 4096 ACU. The step size is 16. One AnalyticDB Compute Unit (ACU) is approximately equivalent to 1 core and 4 GB of memory.

    Note

    Include the unit when you specify this parameter. This parameter is required only when ProductForm is set to LegacyForm.

    32ACU
    StorageResource

    string

    No

    The reserved storage resources. Valid values: 0 ACU to 2064 ACU. The step size is 3 × the number of ACUs specified by the StorageResourceSize parameter. The default value is 24 ACU. One ACU is approximately equivalent to 1 core and 4 GB of memory.

    Note

    Include the unit when you specify this parameter. This parameter is required only when ProductForm is set to LegacyForm.

    24ACU
    StorageResourceSize

    string

    No

    The node specifications for the reserved storage resources. Valid values: 8ACU, 12ACU, and 16ACU.

    Note

    Include the unit when you specify this parameter. This parameter is required only when ProductForm is set to LegacyForm.

    8ACU
    ShardNumber

    string

    No

    The number of shards. Specify this parameter to change the number of shards for the instance during the migration.

    Note

    This parameter is required only when ProductForm is set to LegacyForm.

    128
    ReservedNodeSize

    string

    No

    The node specifications for the reserved storage resources. Valid values: 8ACU, 12ACU, and 16ACU.

    Note

    Include the unit when you specify this parameter. This parameter is required only when ProductForm is set to IntegrationForm.

    8ACU
    ReservedNodeCount

    integer

    No

    The number of reserved nodes.

    • For the Enterprise Edition, the default value is 3 and the step size is 3.

    • For the Basic Edition, the default value is 1.

    Note

    This parameter is required only when ProductForm is set to IntegrationForm.

    3
    ProductVersion

    string

    No

    The product edition. Valid values:

    • BasicVersion: Basic Edition.

    • EnterpriseVersion: Enterprise Edition.

    Note

    This parameter is required only when ProductForm is set to IntegrationForm.

    EnterpriseVersion
    ProductForm

    string

    No

    The product form. Valid values:

    • IntegrationForm: Integrated form.

    • LegacyForm: Data Lakehouse Edition.

    LegacyForm
    SecondaryZoneId

    string

    No

    The ID of the secondary zone.

    Note

    This parameter cannot have the same value as the ZoneId parameter.

    cn-beijing-h
    SecondaryVSwitchId

    string

    No

    The ID of the secondary virtual switch.

    Note

    This parameter cannot have the same value as the VSwitchId parameter.

    vsw-bp1aadw9k19x451gx****
    DryRun

    boolean

    No

    Specifies whether to perform a dry run. Default value: false. Valid values:

    • true: Sends a check request to verify that the migration requirements are met. The migration is not performed.

    • false (Default): Sends a normal request.

    false

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    F0983B43-B2EC-536A-8791-142B5CF1E9B6

    Examples

    Success response

    JSON format

    {
  "RequestId": "F0983B43-B2EC-536A-8791-142B5CF1E9B6"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 IncorrectDBInstanceState The specified instance state does not support this operation. This operation is not supported while the instance is in the current state.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.