将集群创建计划转换成TiUP配置模板
此接口用于将`TEM`创建计划转换成TiUP配置模板,用于支持用户从`TiUP`过度到`TEM`。
入参和集群创建中`Plan`字段内容一致,接口会返回`YAML`字符串。
:::caution 注意
转换函数不会检查主机是否存在。
接口URL
/api/v1/cluster/tidbs/tools/translatePlanToTiUPYAML
请求方式
POST
Content-Type
json
请求Body参数
{
"global": {
"ParameterGroupID": 1,
"ServerConfigs": {
"tidb": {
"log.slow-threshold": 300
}
},
"Variables": {
"tidb_distsql_scan_concurrency": "11"
},
"TiUPOptions": {
"GlobalOptions": {
"User": "tidb",
"SSHPort": 22,
"deployDir": "/data/deploy",
"dataDir": "/data/data"
}
}
},
"Topology": [
{
"Component": "pd",
"Expect": {
"Host": "172.17.0.6",
"Extra": {
"ClientPort": 2379
},
"Resource": {
"CPU": 4,
"Memory": 6
}
}
},
{
"Component": "tikv",
"Expect": {
"Host": "172.17.0.6",
"Extra": {
"Port": 20160,
"StatusPort": 20180
},
"Resource": {
"CPU": 4,
"Memory": 6
}
}
},
{
"Component": "tidb",
"Expect": {
"Host": "172.17.0.6",
"Extra": {
"Port": 4000,
"statusport": 10080
},
"Resource": {
"CPU": 4,
"Memory": 6
},
"Labels": {
"usefor": "oltp"
}
}
},
{
"Component": "tidb",
"Expect": {
"Host": "172.17.0.6",
"Extra": {
"Port": 4001,
"statusport": 10081
},
"Resource": {
"CPU": 4,
"Memory": 6
},
"Labels": {
"usefor": "olap"
}
}
}
]
}
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
global | - | Object | 是 | - |
global.ParameterGroupID | 1 | Integer | 是 | - |
global.ServerConfigs | - | Object | 是 | - |
global.ServerConfigs .tidb |
- | Object | 是 | - |
global.ServerConfigs .tidb.log.slow-threshold |
300 | Integer | 是 | - |
global.Variables | - | Object | 是 | - |
global.Variables .tidb_distsql_scan_concurrency |
11 | String | 是 | - |
global.TiUPOptions | - | Object | 是 | - |
global.TiUPOptions .GlobalOptions |
- | Object | 是 | - |
global.TiUPOptions .GlobalOptions.User |
tidb | String | 是 | 数据库管控账号 |
global.TiUPOptions .GlobalOptions.SSHPort |
22 | Integer | 是 | - |
global.TiUPOptions .GlobalOptions.deployDir |
/data/deploy | String | 是 | - |
global.TiUPOptions .GlobalOptions.dataDir |
/data/data | String | 是 | - |
Topology | - | Array | 是 | - |
Topology.Component | pd | String | 是 | - |
Topology.Expect | - | Object | 是 | - |
Topology.Expect .Host |
172.17.0.6 | String | 是 | - |
Topology.Expect .Extra |
- | Object | 是 | - |
Topology.Expect .Extra.ClientPort |
2379 | Integer | 是 | - |
Topology.Expect .Resource |
- | Object | 是 | - |
Topology.Expect .Resource.CPU |
4 | Integer | 是 | - |
Topology.Expect .Resource.Memory |
6 | Integer | 是 | - |
认证方式
noauth
成功响应示例
{"Data":"global:\n user: tidb\n ssh_port: 22\n deploy_dir: /data/deploy\n data_dir: /data/data\nserver_configs:\n tidb:\n binlog.enable: false\n binlog.ignore-error: true\n enable-telemetry: false\n log.slow-threshold: 300\n new_collations_enabled_on_first_bootstrap: true\n tikv:\n raftstore.apply-pool-size: 4\n raftstore.store-pool-size: 4\n server.grpc-concurrency: 5\n pd:\n dashboard.enable-telemetry: false\n replication.location-labels:\n - zone\n - dc\n - logic\n - rack\n tidb_dashboard: {}\n tiflash: {}\n tiflash-learner: {}\n pump: {}\n drainer: {}\n cdc: {}\n kvcdc: {}\n grafana: {}\ntidb_servers:\n - host: 172.17.0.6\n port: 4000\n status_port: 10080\n config:\n server.labels:\n usefor: oltp\n resource_control:\n memory_limit: 6G\n cpu_quota: 400%\n - host: 172.17.0.6\n port: 4001\n status_port: 10081\n config:\n server.labels:\n usefor: olap\n resource_control:\n memory_limit: 6G\n cpu_quota: 400%\ntikv_servers:\n - host: 172.17.0.6\n port: 20160\n status_port: 20180\n config:\n server.labels: null\n resource_control:\n memory_limit: 6G\n cpu_quota: 400%\ntiflash_servers: []\npd_servers:\n - host: 172.17.0.6\n name: \"\"\n client_port: 2379\n peer_port: 0\n config:\n server.labels: null\n resource_control:\n memory_limit: 6G\n cpu_quota: 400%\nmonitoring_servers: []\n","Success":true}
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
Data | - | String | YAML文本 |
Success | true | Boolean | - |