Creates an AnalyticDB for MySQL Data Lakehouse Edition cluster.
Operation description
For information about the endpoints of AnalyticDB for MySQL, see Endpoints .
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
adb:CreateDBCluster | create |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID. Note
You can call the DescribeRegions operation to query the most recent region list.
| cn-hangzhou |
ZoneId | string | Yes | The zone ID. Note
You can call the DescribeRegions operation to query the most recent zone list.
| cn-hangzhou-h |
DBClusterVersion | string | Yes | The version of the cluster. Set the value to 5.0. | 5.0 |
DBClusterNetworkType | string | Yes | The network type of the cluster. Only VPC is supported. | VPC |
DBClusterDescription | string | No | The description of the cluster.
| test |
PayType | string | Yes | The billing method of the cluster. Valid values:
| Prepaid |
Period | string | No | The subscription type of the subscription cluster. Valid values:
Note
This parameter must be specified when PayType is set to Prepaid.
| Month |
UsedTime | string | No | The subscription duration of the subscription cluster.
Note
This parameter must be specified when PayType is set to Prepaid.
| 3 |
VPCId | string | Yes | The virtual private cloud (VPC) ID of the cluster. | vpc-bp1at5ze0t5u3xtqn**** |
VSwitchId | string | Yes | The vSwitch ID of the cluster. | vsw-bp1aadw9k19x6cis9**** |
StorageResource | string | No | 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 |
ComputeResource | string | No | 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 |
EnableDefaultResourcePool | boolean | No | Specifies whether to allocate all reserved computing resources to the user_default resource group. Valid values:
| true |
ResourceGroupId | string | No | The resource group ID. | rg-4690g37929**** |
Tag | array<object> | No | The tags to add to the cluster. | |
object | No | |||
Key | string | No | 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 Note
The tag key can be up to 64 characters in length and cannot start with aliyun , acs: , http:// , or https:// .
| testkey1 |
Value | string | No | 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 Note
The tag value can be up to 64 characters in length and cannot start with aliyun , acs: , http:// , or https:// .
| test1 |
SourceDbClusterId | string | No | 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**** |
BackupSetId | string | No | 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 |
RestoreToTime | string | No | The point in time to which you want to restore data from the backup set. | 2023-09-20T03:13:56Z |
RestoreType | string | No | The method that you want to use to restore data. Valid values:
| backup |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 time | Summary of changes | Operation |
---|---|---|
2024-05-23 | The request parameters of the API has changed | View Change Details |
2024-05-09 | The request parameters of the API has changed | View Change Details |
2023-08-28 | The request parameters of the API has changed | View Change Details |
2023-07-27 | The request parameters of the API has changed | View Change Details |