该接口用于创建PolarDB集群。

调试

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

请求参数

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

系统规定参数，取值：CreateDBCluster。

DBNodeClass String 是 polar.mysql.x2.medium

节点规格，参见规格与定价。

DBType String 是 MySQL

数据库引擎类型，取值：

  • MySQL。
  • PostgreSQL。
  • Oracle。
DBVersion String 是 5.6

数据库引擎版本号，取值：

  • MySQL：5.6/8.0。
  • PostgreSQL：11。
  • Oracle：11。
PayType String 是 Postpaid

付费类型：

  • Postpaid：按量付费。
  • Prepaid：预付费（包年包月）。
RegionId String 是 ch-hangzhou

地域ID，长度不超过50个字符。

说明 可通过接口DescribeRegions查看可用的地域。
ZoneId String 否 cn-hangzhou-g

可用区ID。

说明 通过接口DescribeRegions查看可用的可用区。
ClusterNetworkType String 否 VPC

当前仅支持VPC。
DBClusterDescription String 否 MySQL测试

集群名称：

  • 以中文、英文字母开头。
  • 可以包含中文、英文字符、数字、”，”、” -”。
  • 不能以http://，https开头。
  • 长度为2-256个字符。
AutoRenew Boolean 否 true

是否自动续费：

  • true：自动续费。
  • false：不自动续费。

默认为false。

说明 当参数PayType取值为PrePaid时才生效。
Period String 否 month

若付费类型为Prepaid时，该参数为必传参数。指定预付费集群为包年或包月类型。

  • Year：包年。
  • Month：包月。
UsedTime String 否 1
  • 当Period为Month时，UsedTime取值为[1-9]。
  • 当Period为Year时，UsedTime取值为[1-3]。
VPCId String 否 vpc-xxxxxxxxxx

专有网络ID。
VSwitchId String 否 vsw-xxxxxxxxxx

虚拟交换机ID。
CreationOption String 否 Normal

创建方式，取值：

默认为Normal。

说明
  • DBType=MySQL且DBVersion=5.6时，本参数取值可以为CloneFromRDS或MigrationFromRDS。
  • DBType=MySQL且DBVersion=8.0时，本参数取值可以为 CreateGdnStandby。
SourceResourceId String 否 rm-bp1xxxxxxxxxx

源RDS实例ID或源PolarDB集群ID。

说明
  • 当DBType=MySQL且DBVersion=5.6时，本参数有意义。
  • 如果CreationOption≠Normal，本参数必填。
CloneDataPoint String 否 LATEST

克隆数据的时间节点，取值：

  • LATEST：最新时间点的数据。
  • BackupID：历史备份集ID，请传入具体的备份集ID。

  • Timestamp：历史时间点，请传入具体的时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

    默认为LATEST。

说明 如果CreationOption=CloneFromRDS，本参数取值只能为LATEST。
ClientToken String 否 6000170000591aed949d0f5xxxxxxxxxxxxxxxxxxx

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

资源组ID。
SecurityIPList String 否 10.xx.xx.10

PolarDB集群白名单。
TDEStatus Boolean 否 true

开启TDE加密。取值：

  • true：开启。
  • false：关闭（默认值）。
说明
  • 当DBType=PostgreSQL或DBType=Oracle时，本参数有意义。
  • TDE功能开启后不可关闭。
GDNId String 否 gdn-bp1xxxxxxxxx

全球数据库网络ID。

说明 当CreationOption=CreateGdnStandby时，本参数必填。

返回数据

名称 类型 示例值 描述
DBClusterId String pc-xxxxxxxxxxxxxxx

集群ID。
OrderId String 20235327xxxxx

订单ID。
RequestId String E056BF3D-1E4F-4E39-B729-8491A74B301B

请求ID。
ResourceGroupId String rg-rexxxxxxxxxx

资源组ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateDBCluster
&DBNodeClass=polar.mysql.x2.medium
&DBType=MySQL
&DBVersion=5.6
&PayType=Postpaid
&RegionId=ch-hangzhou
&<公共请求参数>

正常返回示例

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"
}

错误码

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