将TiUP配置模板转换成集群创建计划

此接口用于将`TiUP`配置模板转换成`TEM`创建计划，用于支持用户从`TiUP`过度到`TEM`。  
入参是用于`TiUP`创建集群的`YAML`字符串，返回集群创建请求中的`Plan`字段内容。
:::caution 注意
转换函数不会检查主机是否存在。
:::

接口URL

/api/v1/cluster/tidbs/tools/translateTiUPYAMLToPlan

请求方式

POST

Content-Type

json

请求Body参数

{
    "Template": "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"
}

参数名	示例值	参数类型	是否必填	参数描述
Template	-	String	是	模板文本

认证方式

noauth

成功响应示例

{
    "Data":{
        "Global":{
            "TiUPOptions":{
                "GlobalOptions":{
                    "User":"tidb",
                    "Group":"",
                    "SSHPort":22,
                    "SSHType":"builtin",
                    "TLSEnabled":false,
                    "DeployDir":"/data/deploy",
                    "DataDir":"/data/data",
                    "LogDir":"",
                    "ResourceControl":{
                        "MemoryLimit":"",
                        "CPUQuota":"",
                        "IOReadBandwidthMax":"",
                        "IOWriteBandwidthMax":"",
                        "LimitCORE":""
                    },
                    "OS":"linux",
                    "Arch":"",
                    "Custom":null
                },
                "MonitoredOptions":{
                    "NodeExporterPort":9100,
                    "BlackboxExporterPort":9115,
                    "DeployDir":"/data/deploy/monitor-9100",
                    "DataDir":"/data/data/monitor-9100",
                    "LogDir":"/data/deploy/monitor-9100/log",
                    "NumaNode":"",
                    "ResourceControl":{
                        "MemoryLimit":"",
                        "CPUQuota":"",
                        "IOReadBandwidthMax":"",
                        "IOWriteBandwidthMax":"",
                        "LimitCORE":""
                    }
                },
                "CommandOptions":{

                }
            },
            "KubernetesOptions":{

            },
            "ServerConfigs":{
                "CDC":{

                },
                "Dashboard":{

                },
                "Drainer":{

                },
                "Grafana":{

                },
                "PD":{
                    "dashboard.enable-telemetry":false,
                    "replication.location-labels":[
                        "zone",
                        "dc",
                        "logic",
                        "rack"
                    ]
                },
                "Pump":{

                },
                "TiDB":{
                    "binlog.enable":false,
                    "binlog.ignore-error":true,
                    "enable-telemetry":false,
                    "log.slow-threshold":300,
                    "new_collations_enabled_on_first_bootstrap":true
                },
                "TiFlash":{

                },
                "TiFlashLearner":{

                },
                "TiKV":{
                    "raftstore.apply-pool-size":4,
                    "raftstore.store-pool-size":4,
                    "server.grpc-concurrency":5
                },
                "TiKVCDC":{

                }
            }
        },
        "Topology":[
            {
                "InstanceID":"",
                "Component":"tidb",
                "Expect":{
                    "Resource":{
                        "CPU":4,
                        "Memory":6
                    },
                    "Host":"172.17.0.6",
                    "Extra":{
                        "AdvertiseAddr":"",
                        "Arch":"",
                        "Config":{
                            "server.labels":{
                                "usefor":"oltp"
                            }
                        },
                        "DeployDir":"/data/deploy/tidb-4000",
                        "Host":"172.17.0.6",
                        "IgnoreExporter":false,
                        "Imported":false,
                        "ListenHost":"",
                        "LogDir":"log",
                        "ManageHost":"",
                        "NumaCores":"",
                        "NumaNode":"",
                        "OS":"",
                        "Patched":false,
                        "Port":4000,
                        "ResourceControl":{
                            "CPUQuota":"400%",
                            "IOReadBandwidthMax":"",
                            "IOWriteBandwidthMax":"",
                            "LimitCORE":"",
                            "MemoryLimit":"6G"
                        },
                        "SSHPort":22,
                        "Source":"",
                        "StatusPort":10080
                    },
                    "Labels":{
                        "usefor":"oltp"
                    }
                }
            },
            {
                "InstanceID":"",
                "Component":"tidb",
                "Expect":{
                    "Resource":{
                        "CPU":4,
                        "Memory":6
                    },
                    "Host":"172.17.0.6",
                    "Extra":{
                        "AdvertiseAddr":"",
                        "Arch":"",
                        "Config":{
                            "server.labels":{
                                "usefor":"olap"
                            }
                        },
                        "DeployDir":"/data/deploy/tidb-4001",
                        "Host":"172.17.0.6",
                        "IgnoreExporter":false,
                        "Imported":false,
                        "ListenHost":"",
                        "LogDir":"log",
                        "ManageHost":"",
                        "NumaCores":"",
                        "NumaNode":"",
                        "OS":"",
                        "Patched":false,
                        "Port":4001,
                        "ResourceControl":{
                            "CPUQuota":"400%",
                            "IOReadBandwidthMax":"",
                            "IOWriteBandwidthMax":"",
                            "LimitCORE":"",
                            "MemoryLimit":"6G"
                        },
                        "SSHPort":22,
                        "Source":"",
                        "StatusPort":10081
                    },
                    "Labels":{
                        "usefor":"olap"
                    }
                }
            },
            {
                "InstanceID":"",
                "Component":"tikv",
                "Expect":{
                    "Resource":{
                        "CPU":4,
                        "Memory":6
                    },
                    "Host":"172.17.0.6",
                    "Extra":{
                        "AdvertiseAddr":"",
                        "AdvertiseStatusAddr":"",
                        "Arch":"",
                        "Config":{
                            "server.labels":null
                        },
                        "DataDir":"/data/data/tikv-20160",
                        "DeployDir":"/data/deploy/tikv-20160",
                        "Host":"172.17.0.6",
                        "IgnoreExporter":false,
                        "Imported":false,
                        "ListenHost":"",
                        "LogDir":"log",
                        "ManageHost":"",
                        "NumaCores":"",
                        "NumaNode":"",
                        "OS":"",
                        "Offline":false,
                        "Patched":false,
                        "Port":20160,
                        "ResourceControl":{
                            "CPUQuota":"400%",
                            "IOReadBandwidthMax":"",
                            "IOWriteBandwidthMax":"",
                            "LimitCORE":"",
                            "MemoryLimit":"6G"
                        },
                        "SSHPort":22,
                        "Source":"",
                        "StatusPort":20180
                    }
                }
            },
            {
                "InstanceID":"",
                "Component":"pd",
                "Expect":{
                    "Resource":{
                        "CPU":4,
                        "Memory":6
                    },
                    "Host":"172.17.0.6",
                    "Extra":{
                        "AdvertiseClientAddr":"",
                        "AdvertisePeerAddr":"",
                        "Arch":"",
                        "ClientPort":2379,
                        "Config":{
                            "server.labels":null
                        },
                        "DataDir":"/data/data/pd-2379",
                        "DeployDir":"/data/deploy/pd-2379",
                        "Host":"172.17.0.6",
                        "IgnoreExporter":false,
                        "Imported":false,
                        "ListenHost":"",
                        "LogDir":"log",
                        "ManageHost":"",
                        "Name":"pd-172.17.0.6-2379",
                        "NumaNode":"",
                        "OS":"",
                        "Patched":false,
                        "PeerPort":2380,
                        "ResourceControl":{
                            "CPUQuota":"400%",
                            "IOReadBandwidthMax":"",
                            "IOWriteBandwidthMax":"",
                            "LimitCORE":"",
                            "MemoryLimit":"6G"
                        },
                        "SSHPort":22,
                        "Source":""
                    }
                }
            }
        ]
    },
    "Success":true
}

参数名	示例值	参数类型	参数描述
Data	-	Object	集群创建计划
Data.Global	-	Object	-
Data.Global .TiUPOptions	-	Object	-
Data.Global .TiUPOptions.GlobalOptions	-	Object	-
Data.Global .TiUPOptions.GlobalOptions .User	tidb	String	数据库管控账号
Data.Global .TiUPOptions.GlobalOptions .Group	-	String	-
Data.Global .TiUPOptions.GlobalOptions .SSHPort	22	Integer	-
Data.Global .TiUPOptions.GlobalOptions .SSHType	builtin	String	-
Data.Global .TiUPOptions.GlobalOptions .TLSEnabled	false	Boolean	-
Data.Global .TiUPOptions.GlobalOptions .DeployDir	/data/deploy	String	-
Data.Global .TiUPOptions.GlobalOptions .DataDir	/data/data	String	-
Data.Global .TiUPOptions.GlobalOptions .LogDir	-	String	-
Data.Global .TiUPOptions.GlobalOptions .ResourceControl	-	Object	-
Data.Global .TiUPOptions.GlobalOptions .ResourceControl .MemoryLimit	-	String	-
Data.Global .TiUPOptions.GlobalOptions .ResourceControl .CPUQuota	-	String	-
Data.Global .TiUPOptions.GlobalOptions .ResourceControl .IOReadBandwidthMax	-	String	-
Data.Global .TiUPOptions.GlobalOptions .ResourceControl .IOWriteBandwidthMax	-	String	-
Data.Global .TiUPOptions.GlobalOptions .ResourceControl .LimitCORE	-	String	-
Data.Global .TiUPOptions.GlobalOptions .OS	linux	String	-
Data.Global .TiUPOptions.GlobalOptions .Arch	-	String	计算平台架构
Data.Global .TiUPOptions.GlobalOptions .Custom	null	Null	-
Data.Global .TiUPOptions.MonitoredOptions	-	Object	-
Data.Global .TiUPOptions.MonitoredOptions .NodeExporterPort	9100	Integer	-
Data.Global .TiUPOptions.MonitoredOptions .BlackboxExporterPort	9115	Integer	-
Data.Global .TiUPOptions.MonitoredOptions .DeployDir	/data/deploy/monitor-9100	String	-
Data.Global .TiUPOptions.MonitoredOptions .DataDir	/data/data/monitor-9100	String	-
Data.Global .TiUPOptions.MonitoredOptions .LogDir	/data/deploy/monitor-9100/log	String	-
Data.Global .TiUPOptions.MonitoredOptions .NumaNode	-	String	-
Data.Global .TiUPOptions.MonitoredOptions .ResourceControl	-	Object	-
Data.Global .TiUPOptions.MonitoredOptions .ResourceControl .MemoryLimit	-	String	-
Data.Global .TiUPOptions.MonitoredOptions .ResourceControl .CPUQuota	-	String	-
Data.Global .TiUPOptions.MonitoredOptions .ResourceControl .IOReadBandwidthMax	-	String	-
Data.Global .TiUPOptions.MonitoredOptions .ResourceControl .IOWriteBandwidthMax	-	String	-
Data.Global .TiUPOptions.MonitoredOptions .ResourceControl .LimitCORE	-	String	-
Data.Global .TiUPOptions.CommandOptions	-	Object	-
Data.Global .KubernetesOptions	-	Object	-
Data.Global .ServerConfigs	-	Object	-
Data.Global .ServerConfigs.CDC	-	Object	-
Data.Global .ServerConfigs.Dashboard	-	Object	-
Data.Global .ServerConfigs.Drainer	-	Object	-
Data.Global .ServerConfigs.Grafana	-	Object	-
Data.Global .ServerConfigs.PD	-	Object	-
Data.Global .ServerConfigs.PD .dashboard.enable-telemetry	false	Boolean	-
Data.Global .ServerConfigs.PD.replication.location-labels	zone	Array	-
Data.Global .ServerConfigs.Pump	-	Object	-
Data.Global .ServerConfigs.TiDB	-	Object	-
Data.Global .ServerConfigs.TiDB .binlog.enable	false	Boolean	-
Data.Global .ServerConfigs.TiDB .binlog.ignore-error	true	Boolean	-
Data.Global .ServerConfigs.TiDB .enable-telemetry	false	Boolean	-
Data.Global .ServerConfigs.TiDB .log.slow-threshold	300	Integer	-
Data.Global .ServerConfigs.TiDB. new_collations_enabled_on _first_bootstrap	true	Boolean	-
Data.Global .ServerConfigs.TiFlash	-	Object	-
Data.Global .ServerConfigs.TiFlashLearner	-	Object	-
Data.Global .ServerConfigs.TiKV	-	Object	-
Data.Global .ServerConfigs.TiKV .raftstore.apply-pool-size	4	Integer	-
Data.Global .ServerConfigs.TiKV .raftstore.store-pool-size	4	Integer	-
Data.Global .ServerConfigs.TiKV .server.grpc-concurrency	5	Integer	-
Data.Global .ServerConfigs.TiKVCDC	-	Object	-
Data.Topology	-	Array	-
Data.Topology .InstanceID	-	String	-
Data.Topology .Component	tidb	String	-
Data.Topology .Expect	-	Object	-
Data.Topology .Expect.Resource	-	Object	-
Data.Topology .Expect.Resource.CPU	4	Integer	-
Data.Topology .Expect.Resource.Memory	6	Integer	-
Data.Topology .Expect.Host	172.17.0.6	String	-
Data.Topology .Expect.Extra	-	Object	-
Data.Topology .Expect.Extra .AdvertiseAddr	-	String	-
Data.Topology .Expect.Extra .Arch	-	String	计算平台架构
Data.Topology .Expect.Extra .Config	-	Object	-
Data.Topology .Expect.Extra .Config.server.labels	-	Object	-
Data.Topology .Expect.Extra .Config.server.labels.usefor	oltp	String	-
Data.Topology .Expect.Extra .DeployDir	/data/deploy/ tidb-4000	String	-
Data.Topology .Expect.Extra .Host	172.17.0.6	String	-
Data.Topology .Expect.Extra .IgnoreExporter	false	Boolean	-
Data.Topology .Expect.Extra .Imported	false	Boolean	-
Data.Topology .Expect.Extra .ListenHost	-	String	-
Data.Topology .Expect.Extra .LogDir	log	String	-
Data.Topology .Expect.Extra .ManageHost	-	String	-
Data.Topology .Expect.Extra .NumaCores	-	String	-
Data.Topology .Expect.Extra .NumaNode	-	String	-
Data.Topology .Expect.Extra .OS	-	String	-
Data.Topology .Expect.Extra .Patched	false	Boolean	-
Data.Topology .Expect.Extra .Port	4000	Integer	-
Data.Topology .Expect.Extra .ResourceControl	-	Object	-
Data.Topology .Expect.Extra .ResourceControl.CPUQuota	400%	String	-
Data.Topology .Expect.Extra .ResourceControl .IOReadBandwidthMax	-	String	-
Data.Topology .Expect.Extra .ResourceControl. IOWriteBandwidthMax	-	String	-
Data.Topology .Expect.Extra .ResourceControl.LimitCORE	-	String	-
Data.Topology .Expect.Extra .ResourceControl.MemoryLimit	6G	String	-
Data.Topology .Expect.Extra .SSHPort	22	Integer	-
Data.Topology .Expect.Extra .Source	-	String	-
Data.Topology .Expect.Extra .StatusPort	10080	Integer	-
Data.Topology .Expect.Labels	-	Object	自定义标签
Data.Topology .Expect.Labels .usefor	oltp	String	-
Success	true	Boolean	-

results matching ""

No results matching ""