All Products
Search

This Product

    AnalyticDB for MySQL:CreateDBCluster

    Document Center

    AnalyticDB for MySQL:CreateDBCluster

    Last Updated:Apr 12, 2024

    Creates an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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:
      • The required resource types are displayed in bold characters.
      • 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:CreateDBClusterWrite
    • DBClusterLakeVersion
      acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    • adb:DiskEncryption
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID.

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

    The zone ID.

    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. Only VPC is supported.

    		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 duration of the subscription cluster.

    • Valid values when Period is set to Year: 1 to 3 (integer).
    • Valid values when Period is set to Month: 1 to 9 (integer).
    Note This parameter must be specified when PayType is set to Prepaid.
    		3
    VPCIdstringYes

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

    		vpc-bp1at5ze0t5u3xtqn****
    VSwitchIdstringYes

    The vSwitch ID of the cluster.

    		vsw-bp1aadw9k19x6cis9****
    StorageResourcestringYes

    The amount of reserved storage resources. Unit: AnalyticDB compute units (ACUs). Valid values: 0 to 2064. The value must be in increments of 24 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.

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

    The amount of reserved computing resources. Unit: ACUs. Valid values: 0 to 4096. The value must be in increments of 16 ACUs. Each ACU is equivalent 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****
    Tagobject []No

    The tags to add to the cluster.

    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. If you want to restore a Data Lakehouse Edition cluster from a Data Warehouse Edition cluster, you must specify this parameter.

    		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

    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 (V3.0) 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
    2023-08-28The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: SourceDbClusterId
      Added Input Parameters: BackupSetId
      Added Input Parameters: RestoreToTime
      Added Input Parameters: RestoreType
    2023-07-27The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ResourceGroupId
      Added Input Parameters: Tag