调用CreateDBCluster接口创建PolarDB集群。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateDBCluster |
系统规定参数。取值:CreateDBCluster。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。 说明 您可以通过DescribeRegions接口查看可用地域。
|
ZoneId | String | 否 | cn-hangzhou-g |
可用区ID。 说明 您可以通过DescribeRegions接口查看可选的可用区。
|
DBType | String | 是 | MySQL |
数据库引擎类型,取值范围如下:
|
DBVersion | String | 是 | 5.6 |
数据库引擎版本号。
|
DBNodeClass | String | 是 | polar.mysql.x2.medium |
节点规格,详情请参见如下文档: |
ClusterNetworkType | String | 否 | VPC |
集群网络类型,当前仅支持专有网络,取值固定为VPC。 |
DBClusterDescription | String | 否 | test |
集群名称,集群名称需满足如下要求:
|
PayType | String | 是 | Postpaid |
付费类型,取值范围如下:
|
AutoRenew | Boolean | 否 | true |
是否自动续费,取值范围如下:
默认为false。 说明 当参数PayType取值为Prepaid时,该参数才生效。
|
Period | String | 否 | Month |
若付费类型为Prepaid时,该参数为必传参数。指定预付费集群为包年或包月类型。
|
UsedTime | String | 否 | 1 |
|
VPCId | String | 否 | vpc-********** |
专有网络ID。 |
VSwitchId | String | 否 | vsw-********** |
虚拟交换机ID。 说明 如果已选择VPCId,则VSwitchId必选。
|
CreationOption | String | 否 | Normal |
创建方式,取值范围如下:
默认为Normal。 说明
|
SourceResourceId | String | 否 | rm-************* |
源RDS实例ID或源PolarDB集群ID。仅当CreationOption为MigrationFromRDS、CloneFromRDS或CloneFromPolarDB时,该参数必填。
|
CloneDataPoint | String | 否 | LATEST |
克隆数据的时间节点,取值:
说明 若CreationOption为CloneFromRDS,则本参数取值只能为LATEST。
|
ClientToken | String | 否 | 6000170000591aed949d0f5******************** |
用于保证请求的幂等性。由客户端生成该参数值,保证在不同请求间唯一,大小写敏感、不超过64个ASCII 字符。 |
ResourceGroupId | String | 否 | rg-************ |
资源组ID。 |
SecurityIPList | String | 否 | 10.***.***.*** |
PolarDB集群白名单IP地址。 说明 支持配置多个白名单IP地址,多个IP地址之间使用英文逗号分隔。
|
TDEStatus | Boolean | 否 | true |
开启TDE加密。取值范围如下:
说明
|
GDNId | String | 否 | gdn-*********** |
全球数据库网络ID。 说明 当CreationOption为CreateGdnStandby时,本参数必填。
|
CreationCategory | String | 否 | Normal |
产品系列,取值范围如下:
说明
更多关产品系列的介绍,请参见于产品系列。 |
DefaultTimeZone | String | 否 | SYSTEM |
集群时区(UTC),可选取值范围为-12:00~+13:00内的所有整点时间,如00:00。默认取值为SYSTEM,默认时区与Region所在时区一致。 说明 仅当DBType为MySQL时,该参数生效。
|
LowerCaseTableNames | String | 否 | 1 |
表名是否区分大小写,取值范围如下:
默认取值为1。 说明 仅当DBType为MySQL时,该参数生效。
|
BackupRetentionPolicyOnClusterDeletion | String | 否 | NONE |
删除集群时备份集保留策略,取值范围如下:
创建集群时,默认取值为NONE,即集群删除时不保留备份集。 说明 仅当DBType为MySQL时,该参数生效。
|
DBMinorVersion | String | 否 | 8.0.1 |
数据库引擎小版本号。
|
ParameterGroupId | String | 否 | pcpg-************** |
参数模板ID。 说明 您可以通过DescribeParameterGroups接口查看目标地域的参数模板列表,包括参数模板ID。
|
Tag.N.Key | String | 否 | type |
标签键。若您需要为目标集群一次性添加多个标签,请单击Add图标添加标签键。 说明 每次最多添加20对标签,
Tag.n.Key 对应的值为Tag.n.Vlaue 。
|
Tag.N.Value | String | 否 | test |
标签值。若您需要为目标集群一次性添加多个标签,请单击Add图标添加标签值。 说明 每次最多添加20对标签,
Tag.n.Vlaue 对应的值为Tag.n.Key 。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | E56531A4-E552-40BA-9C58-137B80****** |
请求ID。 |
ResourceGroupId | String | rg-*************** |
资源组ID。 |
DBClusterId | String | pc-bp1s826a1up****** |
集群ID。 |
OrderId | String | 211454967****** |
订单ID。 |
示例
请求示例
http(s)://polardb.aliyuncs.com/?Action=CreateDBCluster
&DBNodeClass=polar.mysql.x2.medium
&DBType=MySQL
&DBVersion=5.6
&PayType=Postpaid
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateDBClusterResponse>
<RequestId>E56531A4-E552-40BA-9C58-137B80******</RequestId>
<ResourceGroupId>rg-***************</ResourceGroupId>
<DBClusterId>pc-bp1s826a1up******</DBClusterId>
<OrderId>211454967******</OrderId>
</CreateDBClusterResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "E56531A4-E552-40BA-9C58-137B80******",
"ResourceGroupId" : "rg-***************",
"DBClusterId" : "pc-bp1s826a1up******",
"OrderId" : "211454967******"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidBackupRetentionPolicyOnClusterDeletion.Malformed | The specified BackupRetentionPolicyOnClusterDeletion is invalid. | 当前删除(释放)集群时的保留备份策略( BackupRetentionPolicyOnClusterDeletion)无效。 |
400 | InvalidLowerCaseTableNames.Malformed | The specified LowerCaseTableNames is invalid. | 指定的表名是否区分大小写参数(LowerCaseTableNames)无效。 |
400 | InvalidDefaultTimeZone.Malformed | The specified DefaultTimeZone is invalid. | 指定的默认时区参数(DefaultTimeZone)无效。 |
400 | Location.FailedGetSubDomain | The specified regionId does not match the zoneId or the zoneId does not exist. | 指定的地域ID与可用区ID不匹配或者可用区ID不存在 |
400 | InvalidLowerCaseTableNames.Malformed | The Specified LowerCaseTableNames is not valid. | 指定的小写字母名称无效 |
400 | MissParameter.GDNId | The Specified GDNId is needed. | 需要指定的GDNId |
400 | EntityNotExist.ResourceGroup | The resource-group does not exist. | 资源组不存在 |
访问错误中心查看更多错误码。