All Products
Search
Document Center

AnalyticDB:CreateDBCluster

Last Updated:Jan 24, 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
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The description of the cluster.

  • The description cannot start with http:// or https://.
  • The description must be 2 to 256 characters in length
cn-hangzhou
ZoneIdstringYes

The billing method of the cluster. Valid values:

  • Postpaid: pay-as-you-go.
  • Prepaid: subscription.
cn-hangzhou-h
DBClusterVersionstringYes

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.
5.0
DBClusterNetworkTypestringYes

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.
VPC
DBClusterDescriptionstringNo

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

test
PayTypestringYes

The vSwitch ID of the cluster.

Prepaid
PeriodstringNo

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.
Month
UsedTimestringNo

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.
3
VPCIdstringYes

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

  • true (default)
  • false
vpc-bp1at5ze0t5u3xtqn****
VSwitchIdstringYes

The resource group ID.

vsw-bp1aadw9k19x6cis9****
StorageResourcestringNo

The tags to add to the cluster.

24ACU
ComputeResourcestringNo

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://.
16ACU
EnableDefaultResourcePoolbooleanNo

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://.
true
ResourceGroupIdstringNo

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.
rg-4690g37929****
Tagarray<object>No

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

objectNo
KeystringNo

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.
testkey1
ValuestringNo

The region ID of the source cluster.

Note This parameter must be specified for cloning clusters across regions.
test1
SourceDbClusterIdstringNo

The request ID.

amv-bp1r053byu48p****
BackupSetIdstringNo

The default resource group ID.

1880808684
RestoreToTimestringNo

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

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

The order ID.

backup

Response parameters

ParameterTypeDescriptionExample
The current API has no return parameters

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