文档

CreateDBCluster - 创建集群

更新时间:

创建PolarDB集群。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:CreateDBClusterWrite
  • DBCluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

说明 您可以通过 DescribeRegions 接口查看可用地域。
cn-hangzhou
ZoneIdstring

可用区 ID。

说明 您可以通过 DescribeRegions 接口查看可选的可用区。
cn-hangzhou-j
Architecturestring

CPU 架构。取值范围如下:

  • X86
  • ARM
X86
DBTypestring

数据库引擎类型,取值范围如下:

  • MySQL
  • PostgreSQL
  • Oracle
MySQL
DBVersionstring

数据库引擎版本号。

  • MySQL 版本号取值范围如下:
    • 5.6
    • 5.7
    • 8.0
  • PostgreSQL 版本号取值范围如下:
    • 11
    • 14
  • Oracle 版本号取值范围如下:
    • 11
    • 14
5.6
DBNodeClassstring

节点规格,详情请参见如下文档:

说明 如需创建 Serverless 集群,请传入polar.mysql.sl.small
polar.mysql.x4.medium
ClusterNetworkTypestring

集群网络类型,当前仅支持专有网络,取值固定为 VPC

VPC
DBClusterDescriptionstring

集群名称,集群名称需满足如下要求:

  • 不能以http://https://开头。
  • 长度为 2~256 个字符。
test
PayTypestring

付费类型,取值范围如下:

  • Postpaid:按量付费
  • Prepaid:预付费(包年包月)
Postpaid
AutoRenewboolean

是否自动续费,取值范围如下:

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

默认为 false

说明 当参数 PayType 取值为 Prepaid 时,该参数才生效。
true
Periodstring

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

  • Year:包年。即选择包年包月时,单位为年。
  • Month:包月。即选择包年包月时,单位为月。
Month
UsedTimestring

若付费类型为 Prepaid 时,该参数为必传参数。

  • PeriodMonth 时,UsedTime 取值为整数类型,取值范围为[1-9]
  • PeriodYear 时,UsedTime 取值为整数类型,取值范围为[1-3]
1
VPCIdstring

专有网络 ID。

vpc-**********
VSwitchIdstring

虚拟交换机 ID。

说明 如果已选择 VPCId,则 VSwitchId 必选。
vsw-**********
CreationOptionstring

创建方式,取值范围如下:

默认为 Normal

说明 DBTypeMySQLDBVersion8.0时,本参数取值可以为 CreateGdnStandby
Normal
SourceResourceIdstring

源 RDS 实例 ID 或源 PolarDB 集群 ID。仅当 CreationOptionMigrationFromRDSCloneFromRDSCloneFromPolarDBRecoverFromRecyclebin 时,该参数必填。

  • CreationOptionMigrationFromRDSCloneFromRDS,您需要为本参数传入源 RDS 实例 ID。源 RDS 实例版本需为 RDS MySQL 5.6 、5.7 或 8.0 高可用版。

  • CreationOptionCloneFromPolarDB,您需要为本参数传入源 PolarDB 集群 ID。克隆集群和源集群的 DBType 默认保持一致。例如源集群为 MySQL 8.0,则克隆集群也需设置 DBTypeMySQLDBVersion8.0

  • CreationOptionRecoverFromRecyclebin,您需要为本参数传入已释放的源 PolarDB 集群 ID。从回收站恢复的集群和源集群的 DBType 需保持一致。例如源集群为 MySQL 8.0,则从回收站恢复的集群也需设置 DBTypeMySQLDBVersion8.0

rm-*************
CloneDataPointstring

克隆数据的时间节点,取值:

  • LATEST:最新时间点的数据。
  • BackupID:历史备份集 ID,请传入具体的备份集 ID。
  • Timestamp:历史时间点,请传入具体的时间,格式:YYYY-MM-DDThh:mm:ssZ(UTC 时间)。

默认为 LATEST

说明 CreationOptionCloneFromRDS,则本参数取值只能为 LATEST
LATEST
ClientTokenstring

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

6000170000591aed949d0f5********************
ResourceGroupIdstring

资源组 ID。

rg-************
SecurityIPListstring

PolarDB 集群白名单 IP 地址。

说明 支持配置多个白名单 IP 地址,多个 IP 地址之间使用英文逗号分隔。
10.***.***.***
TDEStatusboolean

开启 TDE 加密。取值范围如下:

  • true:开启。
  • false:关闭(默认值)。
说明
  • 仅当 DBTypePostgreSQLOracle 时,本参数生效。
  • 您可以调用 ModifyDBClusterTDE 接口为 PolarDB MySQL 集群开启 TDE 加密。
  • TDE 功能开启后不可关闭。
  • true
    GDNIdstring

    全球数据库网络 ID。

    说明 CreationOptionCreateGdnStandby 时,本参数必填。
    gdn-***********
    CreationCategorystring

    产品系列,取值范围如下:

    • Normal:集群版(默认值)
    • Basic:单节点
    • ArchiveNormal:高压缩引擎(X-Engine)
    • NormalMultimaster:多主架构集群版
    • SENormal:标准版
    说明
  • 仅当 DBTypeMySQL,且 DBVersion5.65.78.0时,支持设置产品系列为 Basic
  • 仅当 DBTypeMySQL,且 DBVersion8.0时,支持设置产品系列为 ArchiveNormalNormalMultimaster
  • 仅当 DBTypeMySQL,且 DBMinorVersion8.0.1时,支持设置产品系列 SENormal
  • 更多关产品系列的介绍,请参见于产品系列

    Normal
    DefaultTimeZonestring

    集群时区(UTC),可选取值范围为**-12:00~+13:00内的所有整点时间,如00:00**。默认取值为 SYSTEM,默认时区与 Region 所在时区一致。

    说明 仅当 DBTypeMySQL 时,该参数生效。
    SYSTEM
    LowerCaseTableNamesstring

    表名是否区分大小写,取值范围如下:

    • 1:不区分大小写
    • 0:区分大小写

    默认取值为 1

    说明 仅当 DBTypeMySQL 时,该参数生效。
    1
    BackupRetentionPolicyOnClusterDeletionstring

    删除集群时备份集保留策略,取值范围如下:

    • ALL:长期保留全部备份。
    • LATEST:长期保留最后一个备份(删除前自动备份)。
    • NONE:集群删除时不保留备份集。

    创建集群时,默认取值为 NONE,即集群删除时不保留备份集。

    说明
  • 仅当 DBTypeMySQL 时,该参数生效。
  • Serverless 集群不支持该参数。
  • NONE
    StorageSpacelong

    按空间计费(包年包月)的存储空间。单位:GB。

    说明 PolarDB MySQL 标准版存储空间的取值范围:20~32000。
    50
    DBMinorVersionstring

    数据库引擎小版本号。取值范围如下:

    • 8.0.2

    • 8.0.1

    说明 当参数 DBTypeMySQLDBVersion8.0时,该参数才生效。
    8.0.1
    ParameterGroupIdstring

    参数模板 ID。

    说明 您可以通过 DescribeParameterGroups 接口查看目标地域的参数模板列表,包括参数模板 ID。
    pcpg-**************
    Tagobject []

    标签列表。

    Keystring

    标签键。若您需要为目标集群一次性添加多个标签,请单击添加增加标签键。

    说明 每次最多添加 20 对标签,Tag.N.Key对应的值为Tag.N.Value
    type
    Valuestring

    标签值。若您需要为目标集群一次性添加多个标签,请单击添加增加标签值。

    说明 每次最多添加 20 对标签,Tag.N.Value对应的值为Tag.N.Key
    test
    ServerlessTypestring

    Serverless 类型。当前取值固定为 AgileServerless(敏态)。

    说明 仅 Serverless 集群支持该参数。
    AgileServerless
    ScaleMinstring

    单节点伸缩下限。取值范围:1 PCU~31 PCU。

    说明 仅 Serverless 集群支持该参数。
    1
    ScaleMaxstring

    单节点伸缩上限。取值范围:1 PCU~32 PCU。

    说明 仅 Serverless 集群支持该参数。
    3
    AllowShutDownstring

    是否开启无活动暂停。取值:

    • true:开启

    • false:关闭(默认)

    说明 仅 Serverless 集群支持该参数。
    true
    ScaleRoNumMinstring

    只读节点个数伸缩下限。取值范围:0~15。

    说明 仅 Serverless 集群支持该参数。
    2
    ScaleRoNumMaxstring

    只读节点个数伸缩上限。取值范围:0~15。

    说明 仅 Serverless 集群支持该参数。
    4
    StorageTypestring

    企业版存储类型取值如下:

    • PSL5
    • PSL4

    标准版存储类型取值如下:

    • ESSDPL0
    • ESSDPL1
    • ESSDPL2
    • ESSDPL3
    • ESSDAUTOPL
    说明 Serverless 集群不支持该参数。
    PSL4
    DBNodeNuminteger

    标准版节点个数。取值如下:

    • 1(默认):表示只有 1 个读写节点。
    • 2:表示有 1 个只读节点和 1 个读写节点。
    说明
  • 企业版默认有 2 个节点,标准版默认有 1 个节点。
  • 仅 PolarDB MySQL 版支持该参数。
  • 1
    HotStandbyClusterstring

    是否开启热备集群。取值范围如下:

    • ON(默认):开启热备集群。
    • OFF:关闭热备集群。
    • STANDBY:标准版开启热备集群。
    说明 标准版集群的默认值为 STANDBY
    ON
    StrictConsistencystring

    集群是否开启了多可用区数据强一致。取值范围如下:

    • ON:表示开启了多可用区数据强一致,适用于标准版 3AZ 场景。

    • OFF:表示未开启多可用区数据强一致。

    ON
    StandbyAZstring

    存储热备集群的可用区。适用于标准版 3AZ 场景。

    说明 开启了多可用区数据强一致,该参数才生效。
    cn-hangzhou-g
    ProxyTypestring

    数据库代理类型,取值范围如下:

    • EXCLUSIVE:企业独享版
    • GENERAL:企业通用版
    说明 代理类型需要与集群的节点规格对应的类型保持一致。即:
  • 节点规格为通用规格,则代理类型应为企业通用版;
  • 节点规格为独享规格,则代理类型应为企业独享版。
  • Exclusive
    ProxyClassstring

    标准版数据库代理规格。取值如下:

    • polar.maxscale.g2.medium.c:2 核。
    • polar.maxscale.g2.large.c:4 核。
    • polar.maxscale.g2.xlarge.c:8 核。
    • polar.maxscale.g2.2xlarge.c:16 核。
    • polar.maxscale.g2.3xlarge.c:24 核。
    • polar.maxscale.g2.4xlarge.c:32 核。
    • polar.maxscale.g2.8xlarge.c:64 核。
    polar.maxscale.g2.medium.c
    LoosePolarLogBinstring

    开启 Binlog 功能,取值范围如下:

    • ON:集群开启 Binlog 功能。
    • OFF:集群关闭 Binlog 功能。
    说明 当参数 DBTypeMySQL 时,该参数才生效。
    ON
    LooseXEnginestring

    开启 X-Engine 存储引擎功能,取值范围如下:

    • ON:集群开启 X-Engine 引擎。
    • OFF:集群关闭 X-Engine 引擎。
    说明 当参数 CreationOption 不等于 CreateGdnStandbyDBTypeMySQLDBVersion8.0时,该参数才生效。开启 X-Engine 引擎的节点内存规格必须大于等于 8 GB。
    ON
    LooseXEngineUseMemoryPctstring

    设置开启 X-Engine 存储引擎比例,取值范围 10~90 的整数。

    说明 当参数 LooseXEngineON 时,该参数才生效。
    50
    StoragePayTypestring

    存储计费类型。取值范围如下:

    • Postpaid:按容量计费(按量付费)。
    • Prepaid:按空间计费(包年包月)。
    Prepaid
    StorageAutoScalestring

    标准版集群是否开启存储自动扩容。取值范围如下:

    • Enable:开启存储自动扩容。
    • Disable:关闭存储自动扩容。
    Enable
    StorageUpperBoundlong

    设置标准版集群存储自动扩容上限,单位:GB。

    说明 取值最大为 32000。
    800
    ProvisionedIopslong

    ESSD AutoPL 云盘预配置的读写 IOPS。可能值:0~min{50,000, 1000*容量-基准性能}。

    基准性能=min{1,800+50*容量, 50000}。

    说明 当 StorageType 为 ESSDAUTOPL 时才支持该参数。
    1000

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    E56531A4-E552-40BA-9C58-137B80******
    ResourceGroupIdstring

    资源组 ID。

    rg-***************
    DBClusterIdstring

    集群 ID。

    pc-bp1s826a1up******
    OrderIdstring

    订单 ID。

    211454967******

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "E56531A4-E552-40BA-9C58-137B80******",
      "ResourceGroupId": "rg-***************",
      "DBClusterId": "pc-bp1s826a1up******",
      "OrderId": "211454967******"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidBackupRetentionPolicyOnClusterDeletion.MalformedThe specified BackupRetentionPolicyOnClusterDeletion is invalid.当前删除(释放)集群时的保留备份策略( BackupRetentionPolicyOnClusterDeletion)无效。
    400InvalidLowerCaseTableNames.MalformedThe specified LowerCaseTableNames is invalid.指定的表名是否区分大小写参数(LowerCaseTableNames)无效。
    400InvalidDefaultTimeZone.MalformedThe specified DefaultTimeZone is invalid.指定的默认时区参数(DefaultTimeZone)无效。
    400Location.FailedGetSubDomainThe specified regionId does not match the zoneId or the zoneId does not exist.指定的地域ID与可用区ID不匹配或者可用区ID不存在。
    400InvalidLowerCaseTableNames.MalformedThe specified LowerCaseTableNames value is invalid.指定的小写字母名称无效。
    400MissParameter.GDNIdThe GDNId parameter is required.需要指定的GDNId。
    400EntityNotExist.ResourceGroupThe resource group does not exist..资源组不存在

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

    变更历史

    变更时间变更内容概要操作
    2023-11-16OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:ProvisionedIops
    2023-10-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    2023-08-03OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:StorageAutoScale
      新增入参:StorageUpperBound
    2023-08-01OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:StoragePayType
    2023-06-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:Architecture
    2023-05-25OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:LoosePolarLogBin
      新增入参:LooseXEngine
      新增入参:LooseXEngineUseMemoryPct
    2023-04-19OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:StrictConsistency
      新增入参:StandbyAZ
    2023-03-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:DBNodeNum
      新增入参:ProxyType
      新增入参:ProxyClass
    2022-11-16OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
    2022-11-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    入参OpenAPI 入参发生变更
      新增入参:StorageType
    • 本页导读 (0)