调用CreateDBInstance接口创建PolarDB-X实例。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateDBInstance

系统规定参数。取值:CreateDBInstance

RegionId String cn-hangzhou

实例所在地域。

PayType String PREPAY

实例付费类型。

  • PREPAY:包年包月
  • POSTPAY:按量付费
DBNodeCount Integer 2

实例节点数量。

DBNodeClass String polarx.x4.2xlarge.2d

节点规格,例如polarx.x4.2xlarge.2e,表示16核64G。

ClientToken String xxxxxx-xxx

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

NetworkType String vpc

网络类型。

  • vpc:专有网络
  • classic:经典网络
VPCId String vpc-*****

VPC ID。

VSwitchId String vsw-*********

虚拟交换机ID。

UsedTime Integer 1

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

Period String Month

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

ResourceGroupId String null

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

AutoRenew Boolean true

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

  • true:是
  • false:否
EngineVersion String 2.0

固定为2.0,不可变更。

IsReadDBInstance Boolean false

是否为只读实例。

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

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

TopologyType String 3azones/1azone

拓扑类型。

PrimaryZone String cn-shenzhen-e

主可用区。

SecondaryZone String cn-shenzhen-a

次可用区。

TertiaryZone String cn-shenzhen-e

第三可用区。

ZoneId String cn-hangzhou-a

实例可用区。

返回数据

名称 类型 示例值 描述
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/1azone
&PrimaryZone=cn-shenzhen-e
&SecondaryZone=cn-shenzhen-a
&TertiaryZone=cn-shenzhen-e
&ZoneId=cn-hangzhou-a
&公共请求参数

正常返回示例

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"
}

错误码

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