接管集群
接管某个已经使用tiup部署的集群
返回信息和新建集群一致
接口URL
/api/v1/cluster/tidbs/takeover
请求方式
POST
Content-Type
application/json
认证方式
Bearer auth
请求Body参数
{
"Creator": "test",
"Alias": "test db",
"Model": "share",
"remote": {
"Host": "127.0.0.1",
"Port": 22,
"User": "sean",
"Password": "123456",
"TiUPHome": "/home/sean/.tiup",
"ClusterName": "tidb-43bd353978db0af4"
},
"User": {
"UserID": "root",
"Password": "pingcap"
},
"ZeroCopy": true
}
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
Creator | test | String | 是 | - |
Alias | test db | String | 是 | 集群别名,可自定义,可重复 |
Model | share | String | 是 | 集群调度模式,share表示共享模式。 |
remote | - | Object | 是 | - |
remote.Host | 127.0.0.1 | String | 是 | - |
remote.Port | 22 | Integer | 是 | - |
remote.User | sean | String | 是 | 远程主机账号 |
remote.Password | 123456 | String | 是 | 远程主机密码 |
remote.TiUPHome | /home/sean/.tiup | String | 是 | tiup home 所在地 |
remote.ClusterName | tidb-43bd353978db0af4 | String | 是 | tiup 中的集群名 |
User | - | Object | 是 | 数据库管控账号,需要有最高权限 |
User.UserID | root | String | 是 | 数据库密码 |
User.Password | pingcap | String | 是 | - |
ZeroCopy | true | Boolean | 是 | 使用原TiUP管理 |
成功响应示例
{
"Data": {
"ClusterID": "tidb-8d1cbd1dc7cee5ff",
"Expect": {
"Resource": {
"CPU": 28,
"Memory": 42
},
"ComponentSize": {
"grafana": 1,
"monitor": 1,
"pd": 1,
"tidb": 2,
"tikv": 2
}
},
"TaskID": "tkf-788a8cb6b8be60cb"
},
"Success": true
}
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
Data | - | Object | |
Data.ClusterID | tidb-8d1cbd1dc7cee5ff | 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-788a8cb6b8be60cb | String | 正在执行的任务流 |
Success | true | Boolean |