CreateDBCluster-阿里云帮助中心

Create a lakehouse cluster.

Operation description

For the service endpoint, see Service 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	The region ID of the cluster. Note You can call the DescribeRegions operation to query the IDs of available regions for Data Lakehouse Edition clusters.	cn-hangzhou
ZoneId	string	Yes	The availability zone ID of the cluster. Note You can call the DescribeRegions operation to query the IDs of available zones for Data Lakehouse Edition clusters.	cn-hangzhou-h
DBClusterVersion	string	Yes	The version of the Data Lakehouse Edition cluster. The value must be 5.0.	5.0
DBClusterNetworkType	string	No	The network type of the cluster. Only VPC 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 long.	test
PayType	string	Yes	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Prepaid
Period	string	No	The unit of the subscription duration. Valid values: Year Month Note This parameter is required if you set `PayType` to `Prepaid`.	Month
UsedTime	string	No	The subscription duration. If `Period` is set to Year, the value of this parameter can be an integer from 1 to 3. If `Period` is set to Month, the value of this parameter can be an integer from 1 to 9. Note This parameter is required if you set `PayType` to Prepaid.	3
VPCId	string	Yes	The VPC ID.	vpc-bp1at5ze0t5u3xtqn****
VSwitchId	string	Yes	The vSwitch ID.	vsw-bp1aadw9k19x6cis9****
StorageResource	string	No	The amount of reserved storage resources in ACUs. The number of ACUs must be an integer from 0 to 2064 and a multiple of 24. 1 ACU is equivalent to approximately 1 core and 4 GB of memory. Note The unit `ACU` must be included in the value. Example: `24ACU`.	24ACU
ComputeResource	string	No	The amount of reserved computing resources in ACUs. The number of ACUs must be an integer from 0 to 4096 and a multiple of 16. 1 ACU is equivalent to approximately 1 core and 4 GB of memory. Note The unit `ACU` must be included in the value. Example: `16ACU`.	16ACU
EnableDefaultResourcePool	boolean	No	Specifies whether to allocate all reserved computing resources to the default resource group `user_default`. Valid values: true (default) false	true
ResourceGroupId	string	No	The resource group ID.	rg-4690g37929****
Tag	array<object>	No	A list of tags.
	object	No
Key	string	No	The tag key. You can specify up to 20 tags. Note The tag key can be up to 64 characters in length. It cannot start with `aliyun`, `acs:`, `http://`, or `https://`.	testkey1
Value	string	No	The tag value. You can specify up to 20 tags. Note The tag value can be up to 64 characters in length. It cannot start with `aliyun`, `acs:`, `http://`, or `https://`.	test1
SourceDbClusterId	string	No	The ID of the source AnalyticDB for MySQL Data Warehouse Edition instance. This parameter is used when restoring a Data Lakehouse Edition cluster from a Data Warehouse Edition cluster.	amv-bp1r053byu48p****
BackupSetId	string	No	The ID of the backup set to use for restoration. Note You can call the DescribeBackups operation to query the backup sets of a cluster.	1880808684
RestoreToTime	string	No	The point in time to which you want to restore the cluster. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC.	2023-09-20T03:13:56Z
RestoreType	string	No	The restoration method. Valid values: backup: restores the cluster from a backup set. You must also specify the `BackupSetId` and `SourceDBClusterId` parameters. timepoint: restores the cluster 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: Integration Form. LegacyForm: Data Lakehouse Edition.	LegacyForm
ReservedNodeSize	string	No	The resource specification of each reserved node, in ACUs.	8ACU
ReservedNodeCount	integer	No	The number of reserved nodes. For Enterprise Edition, the value must be a multiple of 3. The default value is 3. For Basic Edition, the default value is 1. Note This parameter is available only when `ProductForm` is set to `IntegrationForm`.	3
KmsId	string	No	The ID of the key used to encrypt data on cloud disks. Note This parameter takes effect only when disk encryption is enabled for the AnalyticDB for MySQL cluster.	e1935511-cf88-1123-a0f8-1be8d251****
DiskEncryption	boolean	No	Specifies whether to enable disk encryption.	false
CloneSourceRegionId	string	No	The region ID 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 available only when `ProductForm` is set to `IntegrationForm`.	BasicVersion
SecondaryZoneId	string	No	The ID of the secondary availability zone. Note The value of this parameter cannot be the same as the value of the `ZoneId` parameter.	cn-beijing-h
SecondaryVSwitchId	string	No	The ID of the secondary vSwitch. Note The value of this parameter cannot be the same as the value of the `VSwitchId` parameter.	vsw-bp1aadw9k19x451gx****
EnableSSL	boolean	No	Specifies whether to enable SSL encryption. true: enables SSL encryption. false (default): disables SSL encryption.	false

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 Lakehouse Edition (3.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.