集群变配(扩缩容)
接口URL
/api/v1/cluster/tidbs/{clusterID}/scale
请求方式
POST
Content-Type
application/json
认证方式
Bearer auth
路径变量
| 参数名 | 示例值 | 参数描述 |
|---|---|---|
| clusterID | tidb-43bd353978db0af4 | 操作的集群ID |
请求Body参数
{
"Plan": {
"Topology": [
{
"Component": "tidb",
"Expect": {
"Extra": {
"Port": 40010,
"StatusPort": 10091
},
"Resource": {
"cpu": 4,
"memory": 6
}
}
},
{
"Component": "tidb",
"Expect": {
"Control": "destroy"
},
"InstanceID": "inst-tidb-831507a473f4642a"
}
]
}
}
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| Plan | - | Object | 是 | 预期的拓扑结构 |
| Plan.Topology | - | Array | 是 | 新集群中各个组件的拓扑信息 |
| Plan.Topology.Component | tidb | String | 是 | 组件名 |
| Plan.Topology.Expect | - | Object | 是 | - |
| Plan.Topology.Expect.Extra | - | Object | 是 | 自定义配置 |
| Plan.Topology.Expect.Extra.Port | 40010 | Integer | 是 | - |
| Plan.Topology.Expect.Extra.StatusPort | 10091 | Integer | 是 | - |
| Plan.Topology.Expect.Resource | - | Object | 是 | 组件需要的资源 |
| Plan.Topology.Expect.Resource.cpu | 4 | Integer | 是 | - |
| Plan.Topology.Expect.Resource.memory | 6 | Integer | 是 | - |
| Plan.Topology.Expect.Control | destroy | String | 是 | 期望的操作，destroy 代表销毁这个节点 |
成功响应示例
{
"Data": {
"ClusterID": "tidb-43bd353978db0af4",
"Expect": {
"Resource": {
"CPU": 28,
"Memory": 42
},
"ComponentSize": {
"grafana": 1,
"monitor": 1,
"pd": 1,
"tidb": 2,
"tikv": 2
}
},
"TaskID": "tkf-1c82106da9e179ff"
},
"Success": true
}
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| Data | - | Object | |
| Data.ClusterID | tidb-43bd353978db0af4 | String | 集群ID, 集群的全局唯一编号 |
| Data.Expect | - | Object | |
| Data.Expect.Resource | - | Object | |
| Data.Expect.Resource.CPU | 28 | Integer | 集群使用的CPU总量 |
| Data.Expect.Resource.Memory | 42 | Integer | 集群使用的内存总量 |
| Data.Expect.ComponentSize | - | Object | |
| Data.Expect.ComponentSize.grafana | 1 | Integer | |
| Data.Expect.ComponentSize.monitor | 1 | Integer | |
| Data.Expect.ComponentSize.pd | 1 | Integer | |
| Data.Expect.ComponentSize.tidb | 2 | Integer | |
| Data.Expect.ComponentSize.tikv | 2 | Integer | TiKV节点数量 |
| Data.TaskID | tkf-1c82106da9e179ff | String | 正在执行的任务流 |
| Success | true | Boolean |