All Products
Search

This Product

    AnalyticDB:CreateDBCluster

    Document Center

    AnalyticDB:CreateDBCluster

    Last Updated:Jul 01, 2026

    Creates a Data Lakehouse Edition cluster.

    Operation description

    For the service registration of this service, see Endpoint.

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

    create

    *All Resource

    *
    • adb:DiskEncryption
    • adb:EnableSSL
    		 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID.

    Note

    You can call the DescribeRegions operation to query the region ID of a specific Data Lakehouse Edition cluster.

    cn-hangzhou
    ZoneId

    string

    Yes

    The zone ID.

    Note

    You can call the DescribeRegions operation to query the zone ID of a specific Data Lakehouse Edition cluster.

    cn-hangzhou-h
    DBClusterVersion

    string

    Yes

    The version of the Data Lakehouse Edition cluster. Valid values: 5.0.

    5.0
    DBClusterNetworkType

    string

    No

    The network type of the cluster. Only VPC (Virtual Private Cloud) is supported.

    VPC
    DBClusterDescription

    string

    No

    The description of the cluster.

    • The description cannot start with http:// or https://.

    • The description must be 2 to 256 characters in length.

    test
    PayType

    string

    Yes

    The billing method. Valid values:

    • Postpaid: pay-as-you-go.

    • Prepaid: subscription.

    Prepaid
    Period

    string

    No

    The subscription type of the subscription cluster. Valid values:

    • Year: subscription on a yearly basis.

    • Month: subscription on a monthly basis.

    Note

    This parameter is required when PayType is set to Prepaid.

    Month
    UsedTime

    string

    No

    The subscription duration of the subscription cluster. Valid values:

    • When Period is set to Year, the value of UsedTime ranges from 1 to 3 (integer).

    • When Period is set to Month, the value of UsedTime ranges from 1 to 9 (integer).

    Note

    This parameter is required when PayType is set to Prepaid.

    3
    VPCId

    string

    Yes

    The virtual private cloud (VPC) ID.

    vpc-bp1at5ze0t5u3xtqn****
    VSwitchId

    string

    Yes

    The vSwitch ID.

    vsw-bp1aadw9k19x6cis9****
    StorageResource

    string

    No

    The storage reserved resources. Valid values: 0 ACU to 2064 ACU, in increments of 24. 1 ACU is approximately equivalent to 1 core and 4 GB of memory.

    Note

    Include the unit when specifying this parameter.

    24ACU
    ComputeResource

    string

    No

    The compute reserved resources. Valid values: 0 ACU to 4096 ACU, in increments of 16. 1 ACU is approximately equivalent to 1 core and 4 GB of memory.

    Note

    Include the unit when specifying this parameter.

    16ACU
    EnableDefaultResourcePool

    boolean

    No

    Specifies whether to allocate all compute reserved resources to the default resource group (user_default). Valid values:

    • true (default): All compute reserved resources are allocated to the default resource group.

    • false: Not all compute reserved resources are allocated to the default resource group.

    true
    ResourceGroupId

    string

    No

    The resource group ID.

    rg-4690g37929****
    Tag

    array<object>

    No

    The list of tags.

    object

    No

    Key

    string

    No

    The tag key. You can use tags to filter the cluster list. You can specify up to 20 tag pairs. The value of N for each tag pair must be unique and must be a consecutive integer that starts from 1. The value of Tag.N.Key corresponds to the value of Tag.N.Value.

    Note

    The tag key can be up to 64 characters in length and cannot start with aliyun, acs:, http://, or https://.

    testkey1
    Value

    string

    No

    The tag value. You can use tags to filter the cluster list. You can specify up to 20 tag pairs. The value of N for each tag pair must be unique and must be a consecutive integer that starts from 1. The value of Tag.N.Key corresponds to the value of Tag.N.Value.

    Note

    The tag value can be up to 64 characters in length and cannot start with aliyun, acs:, http://, or https://.

    test1
    SourceDbClusterId

    string

    No

    The instance ID of the source AnalyticDB for MySQL Data Warehouse Edition cluster. If this parameter is specified, the Data Lakehouse Edition cluster is used to recover from the Data Warehouse Edition cluster.

    amv-bp1r053byu48p****
    BackupSetId

    string

    No

    The ID of the backup set used for restoration from a backup set.

    Note

    You can call the DescribeBackups operation to query the backup list of the cluster.

    1880808684
    RestoreToTime

    string

    No

    The point in time to which you want to restore data from the backup set.

    2023-09-20T03:13:56Z
    RestoreType

    string

    No

    The restoration method. Valid values:

    • backup: restores data from a backup set. You must also specify the BackupSetId and SourceDBClusterId parameters.

    • timepoint: restores data to a specific point in time. You must also specify the RestoreToTime and SourceDBClusterId parameters.

    backup
    ProductForm

    string

    No

    The product form. Valid values:

    • IntegrationForm: integrated form.

    • LegacyForm: Data Lakehouse Edition.

    LegacyForm
    ReservedNodeSize

    string

    No

    The node specifications of reserved nodes, in ACUs.

    8ACU
    ReservedNodeCount

    integer

    No

    The number of reserved nodes.

    • Enterprise Edition uses 3 nodes by default, in increments of 3.

    • Basic Edition uses 1 node by default.

    Note

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

    3
    KmsId

    string

    No

    The ID of the key used to encrypt cloud disk data.

    Note

    This parameter is used only when cloud disk encryption is enabled for the AnalyticDB for MySQL cluster.

    e1935511-cf88-1123-a0f8-1be8d251****

    DiskEncryption

    boolean

    No

    Specifies whether to enable cloud disk encryption.

    false
    CloneSourceRegionId

    string

    No

    The region of the source cluster.

    Note

    This parameter is required for cross-region cloning.

    cn-beijing
    ProductVersion

    string

    No

    The product version. Valid values:

    • BasicVersion: Basic Edition.

    • EnterpriseVersion: Enterprise Edition.

    Note

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

    BasicVersion
    SecondaryZoneId

    string

    No

    The secondary zone ID.

    Note

    The value of this parameter must be different from the value of the ZoneId parameter.

    cn-beijing-h
    SecondaryVSwitchId

    string

    No

    The secondary vSwitch ID.

    Note

    The value of this parameter must be different from the value of the VSwitchId parameter.

    vsw-bp1aadw9k19x451gx****
    EnableSSL

    boolean

    No

    Specifies whether to enable SSL encryption. Valid values:

    • true: SSL encryption is enabled.

    • false: SSL encryption is disabled.

    false
    AINodeSpec

    string

    No

    ADB.MLPlus.4
    AINodeNumber

    integer

    No

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    1AD222E9-E606-4A42-BF6D-8A4442913CEF
    ResourceGroupId

    string

    The ID of the default resource group.

    rg-4690g37929****
    DBClusterId

    string

    The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

    amv-bp1r053byu48p****
    OrderId

    string

    The order ID.

    202353278****

    Examples

    Success response

    JSON format

    {
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "ResourceGroupId": "rg-4690g37929****",
  "DBClusterId": "amv-bp1r053byu48p****",
  "OrderId": "202353278****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.