该接口用于创建POLARDB集群。

请求参数

名称 类型 是否必须 描述
Action String 系统规定参数,取值:CreateDBCluster。
RegionId String 地域ID,长度不超过50个字符,通过接口DescribeRegions查看可用的地域。
DBType String 数据库类型,取值:
  • MySQL;
  • PostgreSQL;
  • Oracle。
DBVersion String 数据库版本号,取值:
  • MySQL:5.6/8.0;
  • PostgreSQL:11;
  • Oracle:11。
DBNodeClass String 节点规格,参见规格与定价
PayType String 付费类型:
  • Postpaid:按量付费;
  • Prepaid:预付费(包年包月)。
CreationOption String 创建方式,取值:

默认为Normal。

说明 DBType=MySQLDBVersion=5.6时,本参数取值可以为CloneFromRDSMigrationFromRDS
SourceResourceId String 源RDS实例ID或源POLARDB集群ID。
说明
  • DBType=MySQLDBVersion=5.6时,本参数有意义。
  • 如果CreationOptionNormal,本参数必填。
CloneDataPoint String 克隆数据的时间节点,取值:
  • LATEST:最新时间点的数据;
  • <BackupID>:历史备份集ID,请传入具体的备份集ID;
  • <Timestamp>:历史时间点,请传入具体的时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

默认为LATEST。

说明
  • DBType=MySQLDBVersion=5.6,并且CreationOption=CloneFromRDSCloneFromPolarDB本参数有意义。
  • 如果CreationOption=CloneFromRDS,本参数取值只能为LATEST
ZoneId String 可用区ID,通过函数DescribeRegions查看可用的可用区。
ClusterNetworkType String 当前仅支持VPC,默认VPC。
VPCId String 专有网络ID。
VSwitchId String 虚拟交换机ID。
DBClusterDescription String 集群描述:
  • 以中文、英文字母开头;
  • 可以包含中文、英文字符、数字、”,”、” -”;
  • 不能以http://,https开头;
  • 长度为2-256个字符。
AutoRenew String 是否自动续费:
  • true:自动续费;
  • false:不自动续费。

默认为false。

说明 当参数PayType取值为PrePaid时才生效。
Period String 若付费类型为Prepaid时,该参数为必传参数。指定预付费集群为包年或包月类型。
  • Year:包年;
  • Month:包月。
UsedTime String
  • 当Period为Month时,UsedTime取值为[1-9]。
  • 当Period为Year时,UsedTime取值为[1-3]。
ClientToken String 用于保证请求的幂等性。由客户端生成该参数值,保证在不同请求间唯一,大小写敏感、不超过64个 ASCII 字符。

返回参数

名称 类型 描述
<公共返回参数> - 详见公共返回参数
RequestId String RequestId。
DBClusterId String 数据库集群ID。
OrderId String 订单ID。

请求示例

https://polardb.aliyuncs.com/?Action=CreateDBCluster
&RegionId=cn-hangzhou
&DBType=MySQL
&DBVersion=5.6
&DBNodeClass=polar.mysql.x2.medium
&PayType=Postpaid
&<[公共请求参数]>

返回示例

XML格式
<CreateDBClusterResponse>  
    <RequestId>E056BF3D-1E4F-4E39-B729-8491A74B301B</RequestId>
    <OrderId>20235327xxxxx</OrderId>
    <DBClusterId>pc-xxxxxxxxxxxxx</DBClusterId>
</CreateDBClusterResponse>
JSON格式
{
  "RequestId": "E056BF3D-1E4F-4E39-B729-8491A74B301B",
  "OrderId": "20235327xxxxx",
  "DBClusterId": "pc-xxxxxxxxxxxxxxx"
}