All Products
Search

This Product

    AnalyticDB:CreateDBCluster

    Document Center

    AnalyticDB:CreateDBCluster

    Last Updated:Nov 10, 2025

    Creates an AnalyticDB for MySQL Data Lakehouse Edition cluster.

    Operation description

    CreateDBCluster

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    adb:CreateDBClustercreate
    *All Resources
    *
    • adb:DiskEncryption
    • adb:EnableSSL
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the cluster.

    Note You can call the DescribeRegions operation to query the most recent region list.
    		cn-hangzhou
    ZoneIdstringYes

    The zone ID of the cluster.

    Note You can call the DescribeRegions operation to query the most recent zone list.
    		cn-hangzhou-h
    DBClusterVersionstringYes

    The version of the cluster. Set the value to 5.0.

    		5.0
    DBClusterNetworkTypestringYes

    The network type of the cluster. Set the value to VPC.

    		VPC
    DBClusterDescriptionstringNo

    The description of the cluster.

    • The description cannot start with http:// or https://.
    • The description must be 2 to 256 characters in length
    		test
    PayTypestringYes

    The billing method of the cluster. Valid values:

    • Postpaid: pay-as-you-go.
    • Prepaid: subscription.
    		Prepaid
    PeriodstringNo

    The subscription type of the subscription cluster. Valid values:

    • Year: subscription on a yearly basis.
    • Month: subscription on a monthly basis.
    Note This parameter must be specified when PayType is set to Prepaid.
    		Month
    UsedTimestringNo

    The subscription period of the subscription cluster.

    • Valid values when Period is set to Year: 1, 2, and 3 (integer)
    • Valid values when Period is set to Month: 1 to 9 (integer)
    Note
  • This parameter is required if the PayType parameter is set to Prepaid.
  • Longer subscription periods offer more savings. Purchasing a cluster for one year is more cost-effective than purchasing the cluster for 10 or 11 months.
    •
    		1
    VPCIdstringYes

    The virtual private cloud (VPC) ID of the cluster.

    		vpc-bp1at5ze0t5u3xtqn****
    VSwitchIdstringYes

    The vSwitch ID of the cluster.

    		vsw-bp1aadw9k19x6cis9****
    StorageResourcestringNo

    The amount of reserved storage resources. Valid values: 0ACU to 2064ACU. The value must be in increments of 24ACU. Each ACU is approximately equal to 1 core and 4 GB memory.

    Note This parameter must be specified with a unit.
    		24ACU
    ComputeResourcestringNo

    The amount of reserved computing resources. Valid values: 0ACU to 4096ACU. The value must be in increments of 16ACU. Each ACU is approximately equal to 1 core and 4 GB memory.

    Note This parameter must be specified with a unit.
    		16ACU
    EnableDefaultResourcePoolbooleanNo

    Specifies whether to allocate all reserved computing resources to the user_default resource group. Valid values:

    • true (default)
    • false
    		true
    ResourceGroupIdstringNo

    The resource group ID.

    		rg-4690g37929****
    Tagarray<object>No

    The tags to add to the cluster.

    objectNo
    KeystringNo

    The key of tag N to add to the cluster. You can use tags to filter clusters. Valid values of N: 1 to 20. The values that you specify for N must be unique and consecutive integers that start from 1. Each value of Tag.N.Key is paired with a 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
    ValuestringNo

    The value of tag N to add to the cluster. You can use tags to filter clusters. Valid values of N: 1 to 20. The values that you specify for N must be unique and consecutive integers that start from 1. Each value of Tag.N.Key is paired with a 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
    SourceDbClusterIdstringNo

    The ID of the source AnalyticDB for MySQL Data Warehouse Edition cluster.

    		amv-bp1r053byu48p****
    BackupSetIdstringNo

    The ID of the backup set that you want to use to restore data.

    Note You can call the DescribeBackups operation to query the backup sets of the cluster.
    		1880808684
    RestoreToTimestringNo

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

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

    The method that you want to use to restore data. Valid values:

    • backup: restores data from a backup set. You must also specify the BackupSetId and SourceDBClusterId parameters.
    • timepoint: restores data to a point in time. You must also specify the RestoreToTime and SourceDBClusterId parameters.
    		backup
    ProductFormstringNo

    The product form of the cluster. Valid values:

    • IntegrationForm: integrated.
    • LegacyForm: Data Lakehouse Edition.
    		LegacyForm
    ReservedNodeSizestringNo

    The specifications of reserved resource nodes. Unit: ACUs.

    		8ACU
    ReservedNodeCountintegerNo

    The number of reserved resource nodes.

    • For Enterprise Edition, the default value is 3 and the step size is 3.
    • For Basic Edition, the default value is 1.
    Note This parameter must be specified only when ProductForm is set to IntegrationForm.
    		3
    KmsIdstringNo

    The ID of the key that is used to encrypt disk data.

    Note This parameter must be specified only when disk encryption is enabled.
    		e1935511-cf88-1123-a0f8-1be8d251****
    DiskEncryptionbooleanNo

    Specifies whether to enable disk encryption.

    		false
    CloneSourceRegionIdstringNo

    The region ID of the source cluster.

    Note This parameter must be specified for cloning clusters across regions.
    		cn-beijing
    ProductVersionstringNo

    The edition of the cluster. Valid values:

    • BasicVersion: Basic Edition.
    • EnterpriseVersion: Enterprise Edition.
    Note This parameter must be specified only when ProductForm is set to IntegrationForm.
    		BasicVersion
    SecondaryZoneIdstringNo

    The ID of the secondary zone.

    Note You cannot set this parameter to a value that is the same as that of the ZoneId parameter.
    		cn-beijing-h
    SecondaryVSwitchIdstringNo

    The ID of the secondary vSwitch.

    Note You cannot set this parameter to a value that is the same as that of the VSwitchId parameter.
    		vsw-bp1aadw9k19x451gx****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

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

    The default resource group ID.

    		rg-4690g37929****
    DBClusterIdstring

    The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.

    		amv-bp1r053byu48p****
    OrderIdstring

    The order ID.

    		202353278****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-09-24The request parameters of the API has changedView Change Details
    2024-05-23The request parameters of the API has changedView Change Details
    2024-05-09The request parameters of the API has changedView Change Details
    2023-08-28The request parameters of the API has changedView Change Details
    2023-07-27The request parameters of the API has changedView Change Details