创建PolarDB集群。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
polardb:CreateDBCluster | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 说明
您可以通过 DescribeRegions 接口查看可用地域。
| cn-hangzhou |
ZoneId | string | 否 | 可用区 ID。 说明
您可以通过 DescribeRegions 接口查看可选的可用区。
| cn-hangzhou-j |
Architecture | string | 否 | CPU 架构。取值范围如下:
| X86 |
DBType | string | 是 | 数据库引擎类型,取值范围如下:
| MySQL |
DBVersion | string | 是 | 数据库引擎版本号。
| 5.6 |
DBNodeClass | string | 是 | polar.mysql.x4.medium | |
ClusterNetworkType | string | 否 | 集群网络类型,当前仅支持专有网络,取值固定为 VPC。 | VPC |
DBClusterDescription | string | 否 | 集群名称,集群名称需满足如下要求:
| test |
PayType | string | 是 | 付费类型,取值范围如下:
| Postpaid |
AutoRenew | boolean | 否 | 是否自动续费,取值范围如下:
默认为 false。 说明
当参数 PayType 取值为 Prepaid 时,该参数才生效。
| true |
Period | string | 否 | 若付费类型为 Prepaid 时,该参数为必传参数。指定预付费集群为包年或包月类型。
| Month |
UsedTime | string | 否 | 若付费类型为 Prepaid 时,该参数为必传参数。
| 1 |
VPCId | string | 否 | 专有网络 ID。 | vpc-********** |
VSwitchId | string | 否 | 虚拟交换机 ID。 说明
如果已选择 VPCId,则 VSwitchId 必选。
| vsw-********** |
CreationOption | string | 否 | 创建方式,取值范围如下:
默认为 Normal。 说明
当 DBType 为 MySQL 且 DBVersion 为8.0时,本参数取值可以为 CreateGdnStandby。
| Normal |
SourceResourceId | string | 否 | 源 RDS 实例 ID 或源 PolarDB 集群 ID。仅当 CreationOption 为 MigrationFromRDS、CloneFromRDS、CloneFromPolarDB 或 RecoverFromRecyclebin 时,该参数必填。
| rm-************* |
CloneDataPoint | string | 否 | 克隆数据的时间节点,取值:
默认为 LATEST。 说明
若 CreationOption 为 CloneFromRDS,则本参数取值只能为 LATEST。
| LATEST |
ClientToken | string | 否 | 用于保证请求的幂等性。由客户端生成该参数值,保证在不同请求间唯一,大小写敏感、不超过 64 个 ASCII 字符。 | 6000170000591aed949d0f5******************** |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-************ |
SecurityIPList | string | 否 | PolarDB 集群白名单 IP 地址。 说明
支持配置多个白名单 IP 地址,多个 IP 地址之间使用英文逗号分隔。
| 10.***.***.*** |
TDEStatus | boolean | 否 | 开启 TDE 加密。取值范围如下:
说明
| true |
GDNId | string | 否 | 全球数据库网络 ID。 说明
当 CreationOption 为 CreateGdnStandby 时,本参数必填。
| gdn-*********** |
CreationCategory | string | 否 | 产品系列,取值范围如下:
说明
更多关产品系列的介绍,请参见产品系列。 | Normal |
DefaultTimeZone | string | 否 | 集群时区(UTC),可选取值范围为**-12:00~+13:00内的所有整点时间,如00:00**。默认取值为 SYSTEM,默认时区与 Region 所在时区一致。 说明
仅当 DBType 为 MySQL 时,该参数生效。
| SYSTEM |
LowerCaseTableNames | string | 否 | 表名是否区分大小写,取值范围如下:
默认取值为 1。 说明
仅当 DBType 为 MySQL 时,该参数生效。
| 1 |
BackupRetentionPolicyOnClusterDeletion | string | 否 | 删除集群时备份集保留策略,取值范围如下:
创建集群时,默认取值为 NONE,即集群删除时不保留备份集。 说明
| NONE |
StorageSpace | long | 否 | 按空间计费(包年包月)的存储空间。单位:GB。 说明
| 50 |
DBMinorVersion | string | 否 | 数据库引擎小版本号。取值范围如下:
说明
当参数 DBType 为 MySQL 且 DBVersion 为8.0时,该参数才生效。
| 8.0.1 |
ParameterGroupId | string | 否 | 参数模板 ID。 说明
您可以通过 DescribeParameterGroups 接口查看目标地域的参数模板列表,包括参数模板 ID。
| pcpg-************** |
Tag | array<object> | 否 | 标签列表。 | |
object | 否 | |||
Key | string | 否 | 标签键。若您需要为目标集群一次性添加多个标签,请单击添加增加标签键。 说明
每次最多添加 20 对标签, Tag.N.Key 对应的值为Tag.N.Value 。
| type |
Value | string | 否 | 标签值。若您需要为目标集群一次性添加多个标签,请单击添加增加标签值。 说明
每次最多添加 20 对标签, Tag.N.Value 对应的值为Tag.N.Key 。
| test |
ServerlessType | string | 否 | Serverless 类型。当前取值固定为 AgileServerless(敏态)。 说明
仅 Serverless 集群支持该参数。
| AgileServerless |
ScaleMin | string | 否 | 单节点伸缩下限。取值范围:1 PCU~31 PCU。 说明
仅 Serverless 集群支持该参数。
| 1 |
ScaleMax | string | 否 | 单节点伸缩上限。取值范围:1 PCU~32 PCU。 说明
仅 Serverless 集群支持该参数。
| 3 |
AllowShutDown | string | 否 | 是否开启无活动暂停。取值:
说明
仅 Serverless 集群支持该参数。
| true |
ScaleRoNumMin | string | 否 | 只读节点个数伸缩下限。取值范围:0~15。 说明
仅 Serverless 集群支持该参数。
| 2 |
ScaleRoNumMax | string | 否 | 只读节点个数伸缩上限。取值范围:0~15。 说明
仅 Serverless 集群支持该参数。
| 4 |
StorageType | string | 否 | 企业版存储类型取值如下:
标准版存储类型取值如下:
| PSL4 |
DBNodeNum | integer | 否 | 标准版节点个数。取值如下:
说明
| 1 |
HotStandbyCluster | string | 否 | 是否开启热备集群。取值范围如下:
说明
标准版集群的默认值为 STANDBY。
| ON |
StrictConsistency | string | 否 | 集群是否开启了多可用区数据强一致。取值范围如下:
| ON |
StandbyAZ | string | 否 | 存储热备集群的可用区。适用于标准版 3AZ 场景。 说明
开启了多可用区数据强一致,该参数才生效。
| cn-hangzhou-g |
ProxyType | string | 否 | 数据库代理类型,取值范围如下:
说明
代理类型需要与集群的节点规格对应的类型保持一致。即:
| Exclusive |
ProxyClass | string | 否 | 标准版数据库代理规格。取值如下:
| polar.maxscale.g2.medium.c |
LoosePolarLogBin | string | 否 | 开启 Binlog 功能,取值范围如下:
说明
当参数 DBType 为 MySQL 时,该参数才生效。
| ON |
LooseXEngine | string | 否 | 开启 X-Engine 存储引擎功能,取值范围如下:
说明
当参数 CreationOption 不等于 CreateGdnStandby,DBType 为 MySQL 且 DBVersion 为8.0时,该参数才生效。开启 X-Engine 引擎的节点内存规格必须大于等于 8 GB。
| ON |
LooseXEngineUseMemoryPct | string | 否 | 设置开启 X-Engine 存储引擎比例,取值范围 10~90 的整数。 说明
当参数 LooseXEngine 为 ON 时,该参数才生效。
| 50 |
StoragePayType | string | 否 | 存储计费类型。取值范围如下:
| Prepaid |
StorageAutoScale | string | 否 | 标准版集群是否开启存储自动扩容。取值范围如下:
| Enable |
StorageUpperBound | long | 否 | 设置标准版集群存储自动扩容上限,单位:GB。 说明
取值最大为 32000。
| 800 |
ProvisionedIops | long | 否 | ESSD AutoPL 云盘预配置的读写 IOPS。可能值:0~min{50,000, 1000*容量-基准性能}。 基准性能=min{1,800+50*容量, 50000}。 说明 当 StorageType 为 ESSDAUTOPL 时才支持该参数。 | 1000 |
返回参数
示例
正常返回示例
JSON
格式
{
"DBClusterId": "pc-bp1s826a1up******",
"OrderId": "211454967******",
"RequestId": "E56531A4-E552-40BA-9C58-137B80******",
"ResourceGroupId": "rg-***************"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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 value is invalid. | 指定的小写字母名称无效。 |
400 | MissParameter.GDNId | The GDNId parameter is required. | 需要指定的GDNId。 |
400 | EntityNotExist.ResourceGroup | The resource group does not exist.. | 资源组不存在 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-11-16 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-10-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-08-03 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-08-01 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-06-20 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-05-25 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-19 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-03-14 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2022-11-16 | OpenAPI 错误码发生变更 | 查看变更详情 |
2022-11-02 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |