CreateDBCluster
该接口用于创建POLARDB集群。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DBNodeClass | String | 是 | polar.mysql.x2.medium |
节点规格,参见规格与定价。 |
DBType | String | 是 | MySQL |
数据库引擎类型,取值:
|
DBVersion | String | 是 | 5.6 |
数据库引擎版本号,取值:
|
PayType | String | 是 | Postpaid |
付费类型:
|
RegionId | String | 是 | ch-hangzhou |
地域ID,长度不超过50个字符。 说明 可通过接口DescribeRegions查看可用的地域。
|
AccessKeyId | String | 否 | key-test |
阿里云颁发给用户的访问服务所用的密钥ID。 |
Action | String | 否 | CreateDBCluster |
系统规定参数,取值:CreateDBCluster。 |
AutoRenew | Boolean | 否 | true |
是否自动续费:
默认为false。 说明 当参数PayType取值为PrePaid时才生效。
|
ClientToken | String | 否 | 6000170000591aed949d0f54a343f1a4233c1e7d1c5ca816be |
用于保证请求的幂等性。由客户端生成该参数值,保证在不同请求间唯一,大小写敏感、不超过64个 ASCII 字符。 |
CloneDataPoint | String | 否 | LATEST |
克隆数据的时间节点,取值:
说明
|
ClusterNetworkType | String | 否 | VPC |
当前仅支持VPC。 |
CreationOption | String | 否 | Normal |
创建方式,取值:
默认为Normal。 说明 DBType=MySQL且DBVersion=5.6时,本参数取值可以为CloneFromRDS或MigrationFromRDS。
|
DBClusterDescription | String | 否 | MySQL测试 |
集群名称:
|
Period | String | 否 | month |
若付费类型为Prepaid时,该参数为必传参数。指定预付费集群为包年或包月类型。
|
SourceResourceId | String | 否 | rm-bp1avd9fwu111**** |
源RDS实例ID或源POLARDB集群ID。 说明
|
UsedTime | String | 否 | 1 |
|
VPCId | String | 否 | vpc-xxxxxxxxxx |
专有网络ID。 |
VSwitchId | String | 否 | vsw-xxxxxxxxxx |
虚拟交换机ID。 |
ZoneId | String | 否 | cn-hangzhou-g |
可用区ID。 说明 通过接口DescribeRegions查看可用的可用区。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DBClusterId | String | pc-xxxxxxxxxxxxxxx |
集群ID。 |
OrderId | String | 20235327xxxxx |
订单ID。 |
RequestId | String | E056BF3D-1E4F-4E39-B729-8491A74B301B |
请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateDBCluster
&DBNodeClass=polar.mysql.x2.medium
&DBType=MySQL
&DBVersion=5.6
&PayType=Postpaid
&RegionId=ch-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
<CreateDBClusterResponse>
<RequestId>E056BF3D-1E4F-4E39-B729-8491A74B301B</RequestId>
<OrderId>20235327xxxxx</OrderId>
<DBClusterId>pc-xxxxxxxxxxxxx</DBClusterId>
</CreateDBClusterResponse>
JSON
格式
{
"OrderId":"20235327xxxxx",
"RequestId":"E056BF3D-1E4F-4E39-B729-8491A74B301B",
"DBClusterId":"pc-xxxxxxxxxxxxxxx"
}
错误码
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论