AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

创建实例

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

创建PolarDB-X实例。

调试

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

请求参数

名称

类型

是否必选

示例值

描述
Action String 是 CreateDBInstance

系统规定参数。取值：CreateDBInstance。
RegionId String 是 cn-hangzhou

实例所在地域。
PayType String 是 PREPAY

实例付费类型。

  • PREPAY：包年包月
  • POSTPAY：按量付费
DBNodeCount Integer 否 3

实例节点数量:

  • 标准版：1
  • 企业版：>=2
DBNodeClass String 否 polarx.x4.2xlarge.2d

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

标准版本地盘规格：

  • 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(独享)
ClientToken String 否 xxxxxx-xxx

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

网络类型，仅支持VPC网络。
VPCId String 否 vpc-*****

VPC ID。
VSwitchId String 否 vsw-*********

虚拟交换机ID。
UsedTime Integer 否 1

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

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

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

可以为空，资源组ID，暂时不支持。
AutoRenew Boolean 否 true

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

  • true：是
  • false：否
EngineVersion String 是 5.7

mysql引擎版本，5.7或者8.0。
IsReadDBInstance Boolean 否 false

是否为只读实例。

  • true：是
  • false：否
PrimaryDBInstanceName String 否 pxc-*********

如果为只读实例，需要指定主实例。
TopologyType String 是 3azones

拓扑类型：

  • 3azones：三可用区；
  • 1azone：单可用区。
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

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

企业版本地盘：

  • 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（独享）
DnClass String 否 mysql.n4.medium.25

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

企业版本地盘：

  • 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（独享）
CNNodeCount Integer 否 2

计算节点个数。
DNNodeCount Integer 否 2

存储节点个数。
IsColumnarReadDBInstance Boolean 否 true

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

企业版：enterprise

标准版：standard
DnStorageSpace String 否 1500

存储节点磁盘空间大小
ExtraParams Map 否 xxxx

其他参数
String 否 xxxx

其他参数
Description String 否 ods_api_apidata_mobilegame_pay_api_di

数据库描述。
OriginMinorVersion String 否 polardb-2.4.0_standard_xcluster8.4.20-20260331

小版本号，通常不需要传
StorageType String 否 cloud_auto

存储类型

  • 本地盘：custom_local_ssd
  • 云盘：cloud_auto

返回数据

名称

类型

示例值

描述
DBInstanceName String pxc-*********

创建的实例名称。
RequestId String 9B2F3840-5C98-475C-B269-2D5C3A31797C

请求ID。
OrderId String 12345

订单号。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateDBInstance
&RegionId=cn-hangzhou
&PayType=PREPAY
&DBNodeCount=2
&DBNodeClass=polarx.x4.2xlarge.2d
&ClientToken=xxxxxx-xxx
&NetworkType=vpc
&VPCId=vpc-*****
&VSwitchId=vsw-*********
&UsedTime=1
&Period=Month
&ResourceGroupId=null
&AutoRenew=true
&EngineVersion=2.0
&IsReadDBInstance=false
&PrimaryDBInstanceName=pxc-*********
&TopologyType=3azones
&PrimaryZone=cn-shenzhen-e
&SecondaryZone=cn-shenzhen-a
&TertiaryZone=cn-shenzhen-e
&ZoneId=cn-hangzhou-a
&CnClass=polarx.x4.medium.2e
&DnClass=mysql.n4.medium.25
&CNNodeCount=2
&DNNodeCount=2
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDBInstanceResponse>
    <DBInstanceName>pxc-*********</DBInstanceName>
    <RequestId>9B2F3840-5C98-475C-B269-2D5C3A31797C</RequestId>
    <OrderId>12345</OrderId>
</CreateDBInstanceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

上一篇：实例管理下一篇：CheckHealth