AI 助理
文档备案控制台
官方文档
首页 云原生数据库 PolarDB 开发参考 PolarDB分布式版API参考 2.0（2020版本） API目录 实例管理 CreateDBInstance - 创建实例

CreateDBInstance - 创建实例

更新时间：
复制 MD 格式
产品详情
我的收藏

创建PolarDB-X实例。

接口说明

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:CreateDBInstance

create

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

实例所在地域。

cn-hangzhou
PayType

string

是

实例付费类型。

  • PREPAY：包年包月

  • POSTPAY：按量付费

PREPAY
DBNodeCount

integer

否

实例节点数量:

  • 标准版：1

  • 企业版：>=2

3
DBNodeClass

string

否

创建标准时需要传, 企业版无需传。

标准版本地盘规格：

  • mysql.n8.small.25: 1 核 8 GB（通用）

  • mysql.n2.medium.25: 2 核 4 GB（通用）

  • mysql.n4.medium.25: 2 核 8 GB（通用）

  • mysql.n8.medium.25: 2 核 16 GB（通用）

  • mysql.n2.large.25: 4 核 8 GB（通用）

  • mysql.n4.large.25: 4 核 16 GB（通用）

  • mysql.n8.large.25: 4 核 32 GB（通用）

  • mysql.n2.xlarge.25: 8 核 16 GB（通用）

  • mysql.n4.xlarge.25: 8 核 32 GB（通用）

  • mysql.n8.xlarge.25: 8 核 64 GB（通用）

  • mysql.n2.2xlarge.25: 16 核 32 GB（通用）

  • mysql.n4.2xlarge.25: 16 核 64 GB（通用）

  • mysql.n8.2xlarge.25: 16 核 128 GB（通用）

  • mysql.x2.medium.25: 2 核 4 GB（独享）

  • mysql.x4.medium.25: 2 核 8 GB（独享）

  • mysql.x8.medium.25: 2 核 16 GB（独享）

  • mysql.x2.large.25: 4 核 8 GB（独享）

  • mysql.x4.large.25: 4 核 16 GB（独享）

  • mysql.x8.large.25: 4 核 32 GB（独享）

  • mysql.x2.xlarge.25: 8 核 16 GB（独享）

  • mysql.x4.xlarge.25: 8 核 32 GB（独享）

  • mysql.x8.xlarge.25: 8 核 64 GB（独享）

  • mysql.x2.2xlarge.25: 16 核 32 GB（独享）

  • mysql.x4.2xlarge.25: 16 核 64 GB（独享）

  • mysql.x8.2xlarge.25: 16 核 128 GB（独享）

  • mysql.x4.4xlarge.25: 32 核 128 GB（独享）

  • mysql.x8.4xlarge.25: 32 核 256 GB（独享）

  • mysql.x4.8xlarge.25: 64 核 256 GB（独享）

  • mysql.x8.8xlarge.25: 64 核 512 GB（独享）

  • mysql.st.12xlarge.25: 90 核 720 GB（独享）

标准版云盘规格：

  • polarx.mysql.n2.medium.c25: 2 核 4G(通用)

  • polarx.mysql.n4.medium.c25: 2 核 8G(通用)

  • polarx.mysql.n8.medium.c25: 2 核 16G(通用)

  • polarx.mysql.n2.large.c25: 4 核 8G(通用)

  • polarx.mysql.n4.large.c25: 4 核 16G(通用)

  • polarx.mysql.n8.large.c25: 4 核 32G(通用)

  • polarx.mysql.n2.xlarge.c25: 8 核 16G(通用)

  • polarx.mysql.n4.xlarge.c25: 8 核 32G(通用)

  • polarx.mysql.n8.xlarge.c25: 8 核 64G(通用)

  • polarx.mysql.x2.medium.c25: 2 核 4G(独享)

  • polarx.mysql.x4.medium.c25: 2 核 8G(独享)

  • polarx.mysql.x8.medium.c25: 2 核 16G(独享)

  • polarx.mysql.x2.large.c25: 4 核 8G(独享)

  • polarx.mysql.x4.large.c25: 4 核 16G(独享)

  • polarx.mysql.x8.large.c25: 4 核 32G(独享)

  • polarx.mysql.x2.xlarge.c25: 8 核 16G(独享)

  • polarx.mysql.x4.xlarge.c25: 8 核 32G(独享)

  • polarx.mysql.x8.xlarge.c25: 8 核 64G(独享)

  • polarx.mysql.x2.2xlarge.c25: 16 核 32G(独享)

  • polarx.mysql.x4.2xlarge.c25: 16 核 64G(独享)

  • polarx.mysql.x8.2xlarge.c25: 16 核 128G(独享)

  • polarx.mysql.x2.4xlarge.c25: 32 核 64G(独享)

  • polarx.mysql.x4.4xlarge.c25: 32 核 128G(独享)

  • polarx.mysql.x8.4xlarge.c25: 32 核 256G(独享)

  • polarx.mysql.x2.8xlarge.c25: 64 核 128G(独享)

  • polarx.mysql.x4.8xlarge.c25: 64 核 256G(独享)

  • polarx.mysql.x8.8xlarge.c25: 64 核 512G(独享)

polarx.x4.2xlarge.2d
ClientToken

string

否

幂等请求串，保持每次创建不同即可。

xxxxxx-xxx
NetworkType

string

否

网络类型，仅支持 VPC 网络。

vpc
VPCId

string

否

VPC ID。

vpc-*****
VSwitchId

string

否

虚拟交换机 ID。

vsw-*********
UsedTime

integer

否

预付费时，可以选择买几个月或者几年。

说明

Period 设置为 Year 时，该参数支持的取值为 1、2、3。

1
Period

string

否

收费周期，包年包月只能选 Year、Month， 按量付费默认选择 Hour。

Month
ResourceGroupId

string

否

可以为空，资源组 ID，暂时不支持。

null
AutoRenew

boolean

否

是否自动续费，默认为 true。

  • true：是

  • false：否

true
EngineVersion

string

是

mysql 引擎版本，5.7 或者 8.0。

5.7
IsReadDBInstance

boolean

否

是否为只读实例。

  • true：是

  • false：否

false
PrimaryDBInstanceName

string

否

如果为只读实例，需要指定主实例。

pxc-*********
TopologyType

string

是

拓扑类型：

  • 3azones：三可用区；

  • 1azone：单可用区。

3azones
PrimaryZone

string

否

主可用区。

cn-shenzhen-e
SecondaryZone

string

否

次可用区。

cn-shenzhen-a
TertiaryZone

string

否

第三可用区。

cn-shenzhen-e
ZoneId

string

否

实例可用区。

cn-hangzhou-a
CnClass

string

否

计算节点规格，创建企业版需要传，创建标准版无需传。

企业版本地盘：

  • polarx.x4.medium.2e: 2 核 8 GB（通用）

  • polarx.x4.large.2e: 4 核 16 GB（通用）

  • polarx.x4.xlarge.2e: 8 核 32 GB（通用）

  • polarx.x4.2xlarge.2e: 16 核 64 GB（通用）

  • polarx.x8.large.2e: 4 核 32 GB（独享）

  • polarx.x2.large.2x: 8 核 16 GB（独享）

  • polarx.x4.xlarge.2x: 8 核 32 GB（独享）

  • polarx.x8.xlarge.2e: 8 核 64 GB（独享）

  • polarx.x8.2xlarge.2e: 16 核 128 GB（独享）

  • polarx.x4.4xlarge.2e: 32 核 128 GB（独享）

  • polarx.x8.4xlarge.2e: 32 核 256 GB（独享）

  • polarx.st.8xlarge.2e: 60 核 470 GB（独享）

  • polarx.st.12xlarge.2e: 90 核 720 GB（独享）

企业版云盘：

  • polarx.x4.medium.c2e: 2 核 8 GB（通用）

  • polarx.x4.large.c2e: 4 核 16 GB（通用）

  • polarx.x4.xlarge.c2e: 8 核 32 GB（通用）

  • polarx.x4.2xlarge.c2e: 16 核 64 GB（通用）

  • polarx.x8.large.c2e: 4 核 32 GB（独享）

  • polarx.x2.large.c2x: 8 核 16 GB（独享）

  • polarx.x4.xlarge.c2x: 8 核 32 GB（独享）

  • polarx.x8.xlarge.c2e: 8 核 64 GB（独享）

  • polarx.x8.2xlarge.c2e: 16 核 128 GB（独享）

  • polarx.x4.4xlarge.c2e: 32 核 128 GB（独享）

  • polarx.x8.4xlarge.c2e: 32 核 256 GB（独享）

  • polarx.st.8xlarge.c2e: 60 核 470 GB（独享）

  • polarx.st.12xlarge.c2e: 90 核 720 GB（独享）

polarx.x4.medium.2e
DnClass

string

否

存储节点规格，创建企业版需要传，创建标准版无需传。

企业版本地盘：

  • mysql.n2.medium.25: 2 核 4 GB（通用）

  • mysql.n4.medium.25: 2 核 8 GB（通用）

  • mysql.n2.large.25: 4 核 8 GB（通用）

  • mysql.n4.large.25: 4 核 16 GB（通用）

  • mysql.n4.xlarge.25: 8 核 32 GB（通用）

  • mysql.n4.2xlarge.25: 16 核 64 GB（通用）

  • mysql.x4.large.25: 4 核 16 GB（独享）

  • mysql.x8.large.25: 4 核 32 GB（独享）

  • mysql.x2.xlarge.25: 8 核 16 GB（独享）

  • mysql.x8.xlarge.25: 8 核 64 GB（独享）

  • mysql.x8.2xlarge.25: 16 核 128 GB（独享）

  • mysql.x4.4xlarge.25: 32 核 128 GB（独享）

  • mysql.x8.4xlarge.25: 32 核 256 GB（独享）

  • mysql.st.8xlarge.25: 60 核 470 GB（独享）

  • mysql.st.12xlarge.25: 90 核 720 GB（独享）

  • mysql.x8.45xlarge.25: 180 核 1440 GB（独享）

  • mysql.x8.60xlarge.25: 240 核 1920 GB（独享）

企业版云盘：

  • polarx.mysql.n2.medium.c25: 2 核 4 GB（通用）

  • polarx.mysql.n4.medium.c25: 2 核 8 GB（通用）

  • polarx.mysql.n2.large.c25: 4 核 8 GB（通用）

  • polarx.mysql.n4.large.c25: 4 核 16 GB（通用）

  • polarx.mysql.n4.xlarge.c25: 8 核 32 GB（通用）

  • polarx.mysql.n4.2xlarge.c25: 16 核 64 GB（通用）

  • polarx.mysql.x4.large.c25: 4 核 16 GB（独享）

  • polarx.mysql.x8.large.c25: 4 核 32 GB（独享）

  • polarx.mysql.x2.xlarge.c25: 8 核 16 GB（独享）

  • polarx.mysql.x8.xlarge.c25: 8 核 64 GB（独享）

  • polarx.mysql.x8.2xlarge.c25: 16 核 128 GB（独享）

  • polarx.mysql.x4.4xlarge.c25: 32 核 128 GB（独享）

  • polarx.mysql.x8.4xlarge.c25: 32 核 256 GB（独享）

  • polarx.mysql.st.8xlarge.c25: 60 核 470 GB（独享）

  • polarx.mysql.st.12xlarge.c25: 90 核 720 GB（独享）

  • polarx.mysql.x8.45xlarge.c25: 180 核 1440 GB（独享）

  • polarx.mysql.x8.60xlarge.c25: 240 核 1920 GB（独享）

mysql.n4.medium.25
CNNodeCount

integer

否

计算节点个数。

2
DNNodeCount

integer

否

存储节点个数。

2
IsColumnarReadDBInstance

boolean

否

创建的实例是否为列存只读实例。

true
Series

string

否

企业版：enterprise 标准版：standard

enterprise
DnStorageSpace

string

否

存储节点磁盘空间大小

1500
ExtraParams

object

否

其他参数

string

否

其他参数

xxxx
Description

string

否

数据库描述。

ods_api_apidata_mobilegame_pay_api_di
OriginMinorVersion

string

否

小版本号，通常不需要传

polardb-2.4.0_standard_xcluster8.4.20-20260331
StorageType

string

否

存储类型

  • 本地盘：custom_local_ssd

  • 云盘：cloud_auto

cloud_auto

返回参数

名称

类型

描述

示例值

object

DBInstanceName

string

创建的实例名称。

pxc-*********
RequestId

string

请求 ID。

9B2F3840-5C98-475C-B269-2D5C3A31797C
OrderId

string

订单号。

12345

示例

正常返回示例

JSON格式

{
  "DBInstanceName": "pxc-*********",
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "OrderId": "12345"
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：实例管理下一篇：DeleteDBInstance - 删除实例