创建TiDB集群

接口URL

/api/v1/cluster/tidbs/create

请求方式

POST

Content-Type

application/json

认证方式

Bearer auth

请求Body参数

{
    "Alias": "test",
    "Arch": "aarch64",
    "Model": "share",
    "Platform": "tiup",
    "Version": "v6.5.0",
    "User": {
        "UserID": "root",
        "password": "pingcap"
    },
    "Labels": {
        "usefor": "test"
    },
    "Plan": {
        "global": {
            "ServerConfigs": {
                "tidb": {
                    "log.slow-threshold": 300,
                    "binlog.enable": false,
                    "binlog.ignore-error": false
                },
                "pd": {
                    "replication.location-labels": [
                        "zone",
                        "rack",
                        "host",
                        "port"
                    ]
                }
            },
            "Variables": {
                "tidb_distsql_scan_concurrency": "11"
            },
            "TiUPOptions": {
                "GlobalOptions": {
                    "User": "tidb",
                    "SSHPort": 22,
                    "deployDir": "/data/deploy",
                    "dataDir": "/data/data"
                }
            }
        },
        "Topology": [
            {
                "Component": "pd",
                "Expect": {
                    "Extra": {
                        "ClientPort": 2379
                    },
                    "Resource": {
                        "CPU": 4,
                        "Memory": 6
                    }
                }
            },
            {
                "Component": "tikv",
                "Expect": {
                    "Extra": {
                        "Port": 20160,
                        "StatusPort": 20180
                    },
                    "Resource": {
                        "CPU": 4,
                        "Memory": 6
                    }
                },
                "Labels": null
            },
            {
                "Component": "tikv",
                "Expect": {
                    "Extra": {
                        "Port": 20161,
                        "StatusPort": 20181
                    },
                    "Resource": {
                        "CPU": 4,
                        "Memory": 6
                    }
                },
                "Labels": null
            },
            {
                "Component": "monitor",
                "Expect": {
                    "Contral": "create",
                    "Extra": {
                        "Port": 9090
                    },
                    "Resource": {
                        "CPU": 4,
                        "Memory": 6
                    }
                },
                "Labels": null
            },
            {
                "Component": "grafana",
                "Expect": {
                    "Extra": {
                        "Port": 3000
                    },
                    "Resource": {
                        "CPU": 4,
                        "Memory": 6
                    }
                }
            },
            {
                "Component": "tidb",
                "Expect": {
                    "Extra": {
                        "Port": 4000,
                        "statusport": 10080
                    },
                    "Host": "172.17.0.2",
                    "Resource": {
                        "CPU": 4,
                        "Memory": 6
                    },
                    "Labels": {
                        "usefor": "oltp"
                    }
                }
            },
            {
                "Component": "tidb",
                "Expect": {
                    "Extra": {
                        "Port": 4001,
                        "statusport": 10081
                    },
                    "Host": "172.17.0.2",
                    "Resource": {
                        "CPU": 4,
                        "Memory": 6
                    },
                    "Labels": {
                        "usefor": "olap"
                    }
                }
            },
             {
              "Component": "cdc",
              "Expect": {
                  "Extra": {
                      "Port": 8300
                  },
                  "Resource": {
                      "cpu": 4,
                      "memory": 6
                  }
              }
          },
          {
              "Component": "pump",
              "Expect": {
                  "Extra": {
                      "Port": 8250
                  },
                  "Resource": {
                      "cpu": 4,
                      "memory": 6
                  }
              }
          },
            {
              "Component": "drainer",
              "Expect": {
                  "Extra": {
                      "Port": 8249,
                      "config": {
                          "syncer.db-type": "file",
                          "syncer.to.dir": "/path/to/save/binlog",
                          "syncer.to.retention-time": 7
                      }
                  },
                  "Resource": {
                      "cpu": 4,
                      "memory": 6
                  },
                  "Labels": {
                      "usefor": "pitr"
                  }
              }
          }
        ]
    },
    "Creator": "liusx"
}

成功响应示例

{
    "Data": {
        "ClusterID": "tidb-6f2aee582662a5e5",
        "Expect": {
            "Resource": {
                "CPU": 28,
                "Memory": 42
            },
            "ComponentSize": {
                "grafana": 1,
                "monitor": 1,
                "pd": 1,
                "tidb": 2,
                "tikv": 2
            }
        },
        "TaskID": "tkf-dfd7bd85186e13f5"
    },
    "Success": true
}