Creates an AnalyticDB for MySQL cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateDBCluster

The operation that you want to perform. Set the value to CreateDBCluster.

RegionId String Yes cn-hangzhou

The region ID of the cluster. You can call the DescribeRegions operation to query the most recent region list.

ZoneId String No cn-hangzhou-h

The zone ID of the cluster. You can call the DescribeRegions operation to query the most recent zone list.

DBClusterVersion String Yes 3.0

The version of the cluster. Set the value to 3.0.

DBClusterCategory String Yes Cluster

The edition of the cluster. Valid values:

  • Cluster: reserved mode for Cluster Edition
  • MixedStorage: elastic mode for Cluster Edition
Note When DBClusterCategory is set to Cluster, you must set Mode to Reserver. When DBClusterCategory is set to MixedStorage, you must set Mode to Flexible. Otherwise, the cluster cannot be created.
DBClusterClass String No C8

The specification of the cluster. Valid values:

  • C8
  • C32
Note This parameter is required when Mode is set to Reserver.
DBNodeGroupCount String No 2

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

Note This parameter is required when Mode is set to Reserver.
DBNodeStorage String No 200

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 when Mode 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.
DBClusterNetworkType String Yes VPC

The network type of the cluster. Set the value to VPC.

DBClusterDescription String No test

The description of the cluster.

  • The description cannot start with http:// or https.
  • The description must be 2 to 256 characters in length.
PayType String Yes Postpaid

The billing method of the cluster. Valid values:

  • Postpaid: pay-as-you-go
  • Prepaid: subscription
Period String No Year

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 when PayType is set to Prepaid.
UsedTime String No 1

The subscription period 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 is required when PayType is set to Prepaid.
VPCId String No vpc-bp1at5ze0t5u3xtqn****

The ID of the virtual private cloud (VPC).

VSwitchId String No vsw-bp1aadw9k19x6cis9****

The ID of the vSwitch.

ClientToken String No 123e4567-e89b-12d3-a456-t7241****

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.

ExecutorCount String No None

A reserved parameter.

ResourceGroupId String No rg-4690g37929****

The ID of the resource group.

Mode String Yes Reserver

The mode of the cluster. Valid values:

  • Reserver: the reserved mode
  • Flexible: the elastic mode
Note If you do not specify this parameter, the cluster is in reserved mode.
StorageResource String No None

A reserved parameter.

StorageType String No None

A reserved parameter.

ComputeResource String No 32Core128GB

The computing resources of the cluster. You can call the DescribeAvailableResource operation to query the computing resources that are available within a specific region.

Note This parameter is required when Mode is set to Flexible.
RestoreType String No None

A reserved parameter.

SourceDBInstanceName String No None

A reserved parameter.

BackupSetID String No None

A reserved parameter.

RestoreTime String No None

A reserved parameter.

ElasticIOResource String No 0

The number of elastic I/O units (EIUs). For more information, see EIUs.

Response parameters

Parameter Type Example Description
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

ResourceGroupId String rg-4690g37929****

The ID of the resource group.

DBClusterId String am-bp1r053byu48p****

The ID of the cluster.

OrderId String 202353278****

The ID of the order.

Examples

Sample requests

http(s)://adb.aliyuncs.com/?Action=CreateDBCluster
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-h
&DBClusterVersion=3.0
&DBClusterCategory=Cluster
&DBClusterClass=C8
&DBNodeGroupCount=2
&DBNodeStorage=200
&DBClusterNetworkType=VPC
&DBClusterDescription=test
&PayType=Postpaid
&Period=Year
&UsedTime=1
&VPCId=vpc-bp1at5ze0t5u3xtqn****
&VSwitchId=vsw-bp1aadw9k19x6cis9****
&ClientToken=123e4567-e89b-12d3-a456-t7241****
&ResourceGroupId=rg-4690g37929****
&Mode=Reserver
&ComputeResource=32Core128GB
&ElasticIOResource=0
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDBClusterResponse>
    <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
    <ResourceGroupId>rg-4690g37929****</ResourceGroupId>
    <DBClusterId>am-bp1r053byu48p****</DBClusterId>
    <OrderId>202353278****</OrderId>
</CreateDBClusterResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.