创建集群

更新时间：2024-03-11

创建集群

接口描述

本接口用于创建GaiaDB集群。支持按已有集群的备份集或时间点创建集群，即克隆集群。

前提条件

创建集群需要实名认证，没有通过实名认证的可以前往百度智能云官网控制台中的安全认证下的实名认证中进行认证。

说明

本接口用于创建一个或多个相同配置的云原生数据库 GaiaDB 集群。
创建计费方式为后付费的实例需要账户现金余额+通用代金券大于100；预付费方式的实例则需要账户现金余额大于等于集群费用。
创建接口为异步创建，可通过查询集群详情接口查询集群状态。

请求结构

POST /v{version}/gaiadb/cluster?clientToken={clientToken} HTTP/1.1
HOST: gaiadb.bj.baidubce.com
Authorization: authorization string
{
    "number": 1,
    "instanceParam": {
        "engineVersion": "8.0",
        "subnetId": "sbn-cifq6ky2gx9v",
        "allocatedStorageInGB": 5120,
        "allocatedMemoryInMB": 8192,
        "allocatedCpuInCore": 2,
        "engine": "MySQL",
        "vpcId": "vpc-grrb0xpy1xr7",
        "instanceAmount": 2,
        "proxyAmount": 2
    },
    "productType": "postpay"
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	Path参数	API 版本号
clientToken	String	否	Query参数	幂等性Token，是一个长度不超过64位的ASCII字符串
productType	String	是	RequestBody参数	预付费：prepay；后付费：postpay
duration	String	否	RequestBody 参数	预付费时必选参数，购买时长，单位：月
autoRenewTimeUnit	String	否	RequestBody参数	预付费时可选参数，自动续费时长单位，取值：month, year
autoRenewTime	Integer	否	RequestBody参数	预付费时可选参数，自动续费时长。自动续费时长单位为 month 时，取值范围：[1,9]；自动续费时长单位为 year 时，取值范围：[1,3]
number	Integer	是	RequestBody参数	购买集群个数，目前仅支持 1
instanceParam	InstanceParam	是	RequestBody参数	集群实例配置

InstanceParam

参数名称	类型	是否必选	描述
engine	String	是	目前仅支持 MySQL
engineVersion	String	是	取值范围：5.7、8.0
allocatedCpuInCore	Integer	是	CPU 核数。取值参考
allocatedMemoryInMB	Integer	是	套餐内存大小，单位MB。取值参考
allocatedStorageInGB	Integer	是	集群初始磁盘大小，单位GB，目前购买时仅支持 5120
instanceAmount	Integer	是	节点数量，目前购买时仅支持 2，购买成功后可以新增
proxyAmount	Integer	是	代理节点数量，目前购买时仅支持 2，购买成功后可以新增
vpcId	String	是	VPC ID（形如：vpc-grrb0xxxxxxx），可通过调用查询VPC列表接口查询可用的VPC
subnetId	String	是	子网 ID（形如：sbn-cifq6xxxxxx），可通过调用查询子网列表接口查询可用的子网
srcClusterId	String	否	克隆集群时必选参数，源集群 ID
snapshotId	String	否	按备份集克隆集群时必选参数，备份快照 ID（形如：1663426801021394601），可通过调用查询备份列表接口查询可用的备份列表
pit	String	否	按时间点克隆集群时必选参数，时间点对应的 Unix 时间戳（例如 2022-09-19 10:00:00 对应的 Unix 时间戳 1663552800）
lowerCaseTableNames	Integer	否	该参数控制表明大小写是否敏感，有0、1两个取值。0：区分表名大小写； 1：不区分表明大小写。默认是0
resourceGroupId	String	否	资源分组ID
computeTplId	String	否	参数模板ID

返回头域

除公共头域，无其它特殊头域。

返回参数

参数名称	类型	描述
orderId	string	订单 ID
clusterIds	List string	由clusterId组成的数组

请求示例

POST /v1/gaiadb/cluster?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST: gaiadb.bj.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
    "number": 1,
    "instanceParam": {
        "engineVersion": "8.0",
        "subnetId": "sbn-cifq6kxxxxxx",
        "allocatedStorageInGB": 5120,
        "allocatedMemoryInMB": 8192,
        "allocatedCpuInCore": 2,
        "engine": "MySQL",
        "vpcId": "vpc-grrb0xxxxxx",
        "instanceAmount": 2,
        "proxyAmount": 2
    },
    "productType": "postpay"
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
{
    "orderId": "97a868674a964aad8aba2dcb1dxxxxxx",
    "clusterIds": [
        "gaiadbxxxxxx"
    ]
}

Sample-Code

删除集群

云原生数据库 GaiaDB

创建集群

创建集群