All Products
Search
Document Center

AnalyticDB for MySQL:CreateDBCluster

Last Updated:Mar 15, 2024

Operation description

After you create a cluster, you are billed for the cluster specifications that you select. For more information about the billable items and pricing for Data Warehouse Edition (V3.0) clusters, see Billable items of Data Warehouse Edition (V3.0) and Pricing for Data Warehouse Edition (V3.0).

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
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/*
    none
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
ZoneIdstringNo

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 3.0.

3.0
DBClusterCategorystringYes

The edition of the cluster. Valid values:

  • Cluster: reserved mode for Cluster Edition
  • MixedStorage: elastic mode for Cluster Edition
Note If the DBClusterCategory parameter is set to Cluster, you must set the Mode parameter to Reserver. If the DBClusterCategory parameter is set to MixedStorage, you must set the Mode parameter to Flexible. Otherwise, the cluster fails to be created.
Cluster
DBClusterClassstringNo

The specification of the cluster. Valid values:

  • C8
  • C32
Note This parameter is required if the Mode parameter is set to Reserver.
C8
DBNodeGroupCountstringNo

The number of node groups. Valid values: 1 to 200 (integer).

Note This parameter is required if the Mode parameter is set to Reserver.
2
DBNodeStoragestringNo

The storage capacity of the cluster. Unit: GB.

  • Valid values when DBClusterClass is set to C8: 100 to 1000
  • Valid values when DBClusterClass is set to C32: 100 to 8000
Note
  • This parameter is required if the Mode parameter is set to Reserver.
  • 1000 The storage capacity less than 1,000 GB increases in 100 GB increments. The storage capacity greater than 1,000 GB increases in 1,000 GB increments.
  • 200
    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
    Postpaid
    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 is required if the PayType parameter is set to Prepaid.
    Year
    UsedTimestringNo

    The subscription period of the subscription cluster.

    • Valid values when Period is set to Year: 1, 2, 3, and 5 (integer)
    • Valid values when Period is set to Month: 1 to 11 (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
    VPCIdstringNo

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

    vpc-bp1at5ze0t5u3xtqn****
    VSwitchIdstringNo

    The vSwitch ID of the cluster.

    vsw-bp1aadw9k19x6cis9****
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The value is case-sensitive and can contain a maximum of 64 ASCII characters in length.

    123e4567-e89b-12d3-a456-t7241****
    ExecutorCountstringNo

    A reserved parameter.

    N/A
    ResourceGroupIdstringNo

    The ID of the resource group to which the cluster belongs.

    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://.
    tag1
    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
    ModestringYes

    The mode of the cluster. Valid values:

    • Reserver: the reserved mode.
    • Flexible: the elastic mode.
    Reserver
    StorageResourcestringNo

    A reserved parameter.

    N/A
    StorageTypestringNo

    A reserved parameter.

    N/A
    ComputeResourcestringNo

    The computing resources of the cluster. This parameter is required if the Mode parameter is set to Flexible.

    Note You can call the DescribeAvailableResource operation to query the computing resources that are available within a specific region.
    32Core128GB
    RestoreTypestringNo

    A reserved parameter.

    N/A
    SourceDBInstanceNamestringNo

    A reserved parameter.

    N/A
    BackupSetIDstringNo

    A reserved parameter.

    N/A
    RestoreTimestringNo

    A reserved parameter.

    N/A
    ElasticIOResourcestringNo

    The number of elastic I/O units (EIUs). For more information, see Use EIUs to scale up storage resources.

    0
    DiskEncryptionstringNo

    Specifies whether to enable disk encryption.

    Valid values:

    • true
    • false
    true
    KmsIdstringNo

    The Key Management Service (KMS) ID that is used for disk encryption. This parameter is valid only when DiskEncryption is set to true.

    xxxxxxxx-xxxx-xxxx-xxxx-xxxx

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

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

    The ID of the resource group to which the cluster belongs.

    rg-4690g37929****
    DBClusterIdstring

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

    am-bp1r053byu48p****
    OrderIdstring

    The ID of the order.

    202353278****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2024-03-05The internal configuration of the API is changed, but the call is not affectedsee changesets
    Change itemChange content
    The internal configuration of the API is changed, but the call is not affected.
    2023-08-02The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: Tag