变配集群
更新时间：2023-07-04
变配集群
接口描述
为指定云原生数据库 GaiaDB 集群所用资源扩缩容，目前支持增删计算节点、变更计算节点规格、增删入口、变更入口下代理节点个数。
说明
- 只有集群available状态时才可以进行变配操作。
- 异步接口，可通过查询集群详情接口查看instanceStatus是否恢复。
请求结构
PUT /v{version}/gaiadb/cluster/{clusterId}?resize HTTP/1.1
HOST: gaiadb.bj.baidubce.com
Authorization: authorization string
{
"resizeType": "resizeSlave",
"allocatedCpuInCore": 2,
"allocatedMemoryInMB": 8192
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | Path参数 | API 版本号 |
| clusterId | String | 是 | Path参数 | 指定集群Id |
| resize | String | 是 | Query参数 | 变配操作标志，无需设置任何值 |
| resizeType | String | 是 | RequestBody参数 | 变配类型，取值，新增一个节点：addSlave；删除一个节点：delSlave；变更节点规格：resizeSlave；增加入口：addInterface；删除入口：delInterface；变更入口代理节点个数：resizeInterfaceProxyAmount； |
| slaveId | String | 否 | RequestBody参数 | 删除节点必选参数，要删除的节点的ID。查询集群详情API返回的 .computeList[0].instanceId |
| allocatedCpuInCore | Integer | 否 | RequestBody参数 | 变更节点规格必选参数，节点CPU核数。取值参考 |
| allocatedMemoryInMB | Integer | 否 | RequestBody参数 | 变更节点规格必选参数，节点内存大小，单位MB。取值参考 |
| proxyAmount | Integer | 否 | RequestBody参数 | 入口代理节点个数（期望变更后的个数），变更代理节点个数时必填 |
| interfaceId | Integer | 否 | RequestBody参数 | 删除入口或变更入口代理节点数时的入口 ID，在此情景下为必填 |
| interfacee | Interfacee | 否 | RequestBody参数 | 入口参数结构 |
Interfacee
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| addressName | String | 否 | RequestBody参数 | 地址名称 |
| instanceBinding | List String | 否 | RequestBody参数 | 绑定节点 instanceUniqueId |
| proxyAmount | Integer | 否 | RequestBody参数 | 入口代理节点个数，此数值默认为2，需要添加多少个代理节点可在此基础上累加。注该参数在新增代理节点时为必填项 |
| readWriteMode | String | 否 | RequestBody参数 | 新建入口的类型可选值: readWrite、readonly |
| masterReadable | Integer | 否 | RequestBody参数 | 主库是否接受读: 0、1，1代表主库接受读 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| orderId | String | 变配订单 ID |
请求示例
PUT /v1/gaiadb/cluster/gaiadbxxxxxx?resize HTTP/1.1
HOST: gaiadb.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"resizeType": "resizeSlave",
"allocatedCpuInCore": 2,
"allocatedMemoryInMB": 8192
}返回示例
HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
{
"orderId": "42674b677b7a42d3985af7395687a585"
}