调用CreateDBCluster接口创建一个AnalyticDB MySQL集群。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateDBCluster

系统规定参数,取值:

CreateDBCluster

DBClusterCategory String Cluster

系列。取值说明:

  • Cluster:预留模式集群版。
说明 仅中国内地地域和新加坡地域支持购买预留模式集群版。其中,新加坡地域仅支持在按量付费模式下购买预留模式集群版。
  • MixedStorage:弹性模式集群版(新版)。
说明 当DBClusterCategory为Cluster时,Mode参数必须填写Reserver;当DBClusterCategory为MixedStorage时,Mode参数必须填写Flexible,否则会导致创建集群失败。
DBClusterNetworkType String VPC

网络类型:VPC

DBClusterVersion String 3.0

AnalyticDB MySQL集群版本,取值:3.0

Mode String Reserver

模式。取值说明:

  • Reserver:预留模式。
  • Flexible:弹性模式。
说明 本参数不填写时,默认为预留模式。
PayType String Postpaid

付费类型。取值说明:

  • Postpaid:按量付费。
  • Prepaid:预付费(包年包月)。
RegionId String cn-hangzhou

地域ID,通过DescribeRegions查看可用的地域。

ZoneId String cn-hangzhou-h

可用区ID,通过DescribeRegions查看可用的地域。

DBClusterDescription String test

备注信息。

DBNodeGroupCount String 2

节点组数量,取值范围为:1~200。

说明 Mode取值为Reserver(即预留模式)时,本参数必填。
DBClusterClass String C8

规格,取值:

  • C8
  • C32
说明 Mode取值为Reserver(即预留模式)时,本参数必填。
DBNodeStorage String 200

节点存储空间,取值说明:

  • 规格为C8时,取值范围为:100~1000GB。
  • 规格为C32时,取值范围为:100~8000GB。
说明
  • Mode取值为Reserver(即预留模式)时,本参数必填。
  • 1000GB以下步长为100GB,1000GB以上步长为1000GB。
ComputeResource String 32Core128GB

计算资源,您可以调用DescribeAvailableResource接口查询指定地域中可用的计算资源。

说明 Mode取值为Flexible(即弹性模式)时,本参数必填。
Period String Year

指定预付费集群为包年或包月类型。取值说明:

  • Year:包年类型。
  • Month:包月类型。
说明 PayType为Prepaid(即预付费(包年包月))时,本参数为必填参数。
UsedTime String 1

使用时间。取值说明:

  • 当Period为Year时,UsedTime取值范围为:1~3。
  • 当Period为Month时,UsedTime取值范围为:1~9。
说明 PayType为Prepaid(即预付费(包年包月))时,本参数为必填参数。
VPCId String vpc-xxxxxxxx

专有网络ID。

VSwitchId String vsw-xxxxxxxx

虚拟交换机ID。

ResourceGroupId String rg-xxxxxxxx

资源组ID。

ClientToken String 123e4567-e89b-12d3-a456-xxxxxxxx

用于保证请求的幂等性。由客户端生成该参数值,保证在不同请求间唯一。大小写敏感、不超过64个ASCII 字符。

StorageResource String

不涉及。

StorageType String

不涉及。

RestoreType String

不涉及。

ExecutorCount String

不涉及。

SourceDBInstanceName String

不涉及。

BackupSetID String

不涉及。

RestoreTime String

不涉及。

ElasticIOResource String 0

弹性IO资源(Elastic IO Unit,简称EIU),更多详情,请参见EIU详解

返回数据

名称 类型 示例值 描述
DBClusterId String am-bpxxxxxxxx47

集群ID。

OrderId String 20235327xxxxx

订单ID。

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

请求ID。

ResourceGroupId String rg-xxxxxxxx

资源组ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateDBCluster
&DBClusterCategory=Cluster
&DBClusterClass=C8
&DBClusterNetworkType=VPC
&DBClusterVersion=3.0
&DBNodeGroupCount=2
&DBNodeStorage=200
&Mode=Reserver
&PayType=Postpaid
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<ResourceGroupId>rg-xxxxxxxx</ResourceGroupId>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<DBClusterId>am-bpxxxxxxxx47</DBClusterId>
<OrderId>20235327xxxxx</OrderId>

JSON格式

{
    "ResourceGroupId": "rg-xxxxxxxx",
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "DBClusterId": "am-bpxxxxxxxx47",
    "OrderId": "20235327xxxxx"
}

错误码

访问错误中心查看更多错误码。