All Products
Search

This Product

    AnalyticDB:CreateDBCluster

    Document Center

    AnalyticDB:CreateDBCluster

    Last Updated:Mar 17, 2026

    Creates a Data Lakehouse Edition cluster.

    Operation description

    For information about the service endpoint, see Endpoints.

    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

    Region ID.

    Note

    Call the DescribeRegions interface to view the region ID of the specified Data Lakehouse Edition cluster.

    cn-hangzhou
    ZoneId

    string

    Yes

    Zone ID.

    Note

    Call the DescribeRegions interface to view the zone ID of the specified Data Lakehouse Edition cluster.

    cn-hangzhou-h
    DBClusterVersion

    string

    Yes

    The version of the Data Lakehouse Edition cluster. Value: 5.0.

    5.0
    DBClusterNetworkType

    string

    No

    Cluster network type. Only VPC (virtual private cloud) is supported.

    VPC
    DBClusterDescription

    string

    No

    Cluster description.

    • Do not start with http:// or https://.

    • Length is 2 to 256 characters.

    test
    PayType

    string

    Yes

    Billing method. Values:

    • Postpaid: pay-as-you-go.

    • Prepaid: subscription.

    Prepaid
    Period

    string

    No

    Specify whether a subscription cluster is annual or monthly. Values:

    • Year: Annual subscription.

    • Month: Monthly subscription.

    Note

    This parameter is required when PayType is Prepaid (subscription).

    Month
    UsedTime

    string

    No

    Specify the subscription duration for a subscription cluster. Values:

    • If Period is Year, UsedTime ranges from 1 to 3 (integer).

    • If Period is Month, UsedTime ranges from 1 to 9 (integer).

    Note

    This parameter is required when PayType is Prepaid (subscription).

    3
    VPCId

    string

    Yes

    VPC ID.

    vpc-bp1at5ze0t5u3xtqn****
    VSwitchId

    string

    Yes

    Virtual switch ID.

    vsw-bp1aadw9k19x6cis9****
    StorageResource

    string

    No

    Storage reserved resources. Range: 0 ACU to 2064 ACU. Step size: 24. 1 ACU is approximately 1 core and 4 GB.

    Note

    Include the unit when specifying the parameter.

    24ACU
    ComputeResource

    string

    No

    Compute reserved resources. Range: 0 ACU to 4096 ACU. Step size: 16. 1 ACU is approximately 1 core and 4 GB.

    Note

    Include the unit when specifying the parameter.

    16ACU
    EnableDefaultResourcePool

    boolean

    No

    Whether to allocate all compute reserved resources to the default resource group (user_default). Values:

    • true (default): Yes.

    • false: No.

    true
    ResourceGroupId

    string

    No

    Resource group ID.

    rg-4690g37929****
    Tag

    array<object>

    No

    Tag list information.

    object

    No

    Key

    string

    No

    Tag key. Use tags to filter the cluster list. Up to 20 tag pairs are allowed. The number 'n' for each tag pair must be unique and a consecutive integer starting from 1. Tag.N.Key corresponds to Tag.N.Value.

    Note

    Up to 64 characters. Do not start with aliyun, acs:, http://, or https://.

    testkey1
    Value

    string

    No

    Tag value. Use tags to filter the cluster list. Up to 20 tag pairs are allowed. The number 'n' for each tag pair must be unique and a consecutive integer starting from 1. Tag.N.Key corresponds to Tag.N.Value.

    Note

    Up to 64 characters. Do not start with aliyun, acs:, http://, or https://.

    test1
    SourceDbClusterId

    string

    No

    The source instance ID of the AnalyticDB MySQL Data Warehouse Edition cluster. Specify this parameter to recover a Data Lakehouse Edition cluster from a Data Warehouse Edition cluster.

    amv-bp1r053byu48p****
    BackupSetId

    string

    No

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

    Note

    Call the DescribeBackups interface to view the cluster's backup list.

    1880808684
    RestoreToTime

    string

    No

    The point in time for recovery from a backup set.

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

    string

    No

    Recovery method. Values:

    • backup: Recover from a backup set. You must also provide the BackupSetId and SourceDBClusterId parameters.

    • timepoint: Recover to a point in time. You must also provide the RestoreToTime and SourceDBClusterId parameters.

    backup
    ProductForm

    string

    No

    Product form. Values:

    • IntegrationForm: Integrated form.

    • LegacyForm: Data Lakehouse Edition.

    LegacyForm
    ReservedNodeSize

    string

    No

    Reserved node specifications, in ACU.

    8ACU
    ReservedNodeCount

    integer

    No

    Reserved node count.

    • Enterprise Edition defaults to 3 nodes, with a step size of 3.

    • Basic Edition defaults to 1 node.

    Note

    Provide this parameter only when ProductForm is IntegrationForm.

    3
    KmsId

    string

    No

    The key ID used to encrypt cloud disk data.

    Note

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

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

    DiskEncryption

    boolean

    No

    Enable disk encryption.

    false
    CloneSourceRegionId

    string

    No

    The region where the source cluster is located.

    Note

    This parameter is required for cross-region cloning.

    cn-beijing
    ProductVersion

    string

    No

    Edition. Values:

    • BasicVersion: Basic Edition.

    • EnterpriseVersion: Enterprise Edition.

    Note

    Provide this parameter only when ProductForm is IntegrationForm.

    BasicVersion
    SecondaryZoneId

    string

    No

    Secondary zone ID.

    Note

    The value for this parameter cannot be the same as the ZoneId parameter.

    cn-beijing-h
    SecondaryVSwitchId

    string

    No

    Secondary virtual switch ID.

    Note

    The value for this parameter cannot be the same as the VSwitchId parameter.

    vsw-bp1aadw9k19x451gx****
    EnableSSL

    boolean

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    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 MySQL Data Lakehouse Edition (3.0) cluster.

    amv-bp1r053byu48p****
    OrderId

    string

    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.