同步集群状态

同步集群节点信息以及访问终端信息。

接口URL

/api/v1/cluster/tidbs/{clusterID}/sync

请求方式

POST

Content-Type

application/json

认证方式

Bearer auth

路径变量

参数名 示例值 参数描述
clusterID tidb-dabc90ff63ee07eb -

成功响应示例

{
    "Data": {
        "Abstract": {
            "ComponentSize": {
                "grafana": 1,
                "monitor": 1,
                "pd": 1,
                "tidb": 2,
                "tikv": 2
            },
            "Resource": {
                "CPU": 28,
                "Memory": 42
            }
        },
        "AccessEntrys": {
            "DB": {
                "Description": "tidb Access address",
                "Host": "172.17.0.7",
                "Port": 4000,
                "Type": "mysql",
                "UseFor": ""
            },
            "Dashboard": {
                "Description": "tidb dashboard",
                "Host": "172.17.0.7",
                "Port": 2379,
                "Type": "http",
                "UseFor": ""
            }
        },
        "Alias": "test",
        "Arch": "aarch64",
        "ClusterID": "tidb-43bd353978db0af4",
        "Config": {
            "Global": {
                "MaxReplicas": 3,
                "ServerConfigs": {
                    "pd": {
                        "replication.location-labels": [
                            "zone",
                            "rack",
                            "host",
                            "port"
                        ]
                    },
                    "tidb": {
                        "binlog.enable": false,
                        "binlog.ignore-error": false,
                        "enable-telemetry": false,
                        "log.slow-threshold": 400
                    }
                },
                "TiUPOptions": {
                    "GlobalOptions": {
                        "SSHPort": 22,
                        "User": "tidb",
                        "dataDir": "/data/data",
                        "deployDir": "/data/deploy"
                    }
                },
                "Variables": {
                    "tidb_distsql_scan_concurrency": "15"
                }
            }
        },
        "Control": "",
        "CreatedAt": "2023-09-19T11:50:40.768+08:00",
        "Creator": "liusx",
        "Description": "",
        "Labels": {
            "usefor": "test"
        },
        "MetaID": 7280379714100683776,
        "Model": "share",
        "Platform": "tiup",
        "Status": "running",
        "TaskID": "",
        "Topology": [
            {
                "Component": "pd",
                "Control": "",
                "InstanceID": "inst-pd-ba224b801c4f0935",
                "StartTime": "0001-01-01T00:00:00Z",
                "Status": "running"
            },
            {
                "Component": "tikv",
                "Control": "",
                "InstanceID": "inst-tikv-c988c96664886ca1",
                "StartTime": "0001-01-01T00:00:00Z",
                "Status": "running"
            },
            {
                "Component": "tikv",
                "Control": "",
                "InstanceID": "inst-tikv-8c3542b231c2c0e1",
                "StartTime": "0001-01-01T00:00:00Z",
                "Status": "running"
            },
            {
                "Component": "monitor",
                "Control": "",
                "InstanceID": "inst-monitor-e2b404521f5f4850",
                "StartTime": "0001-01-01T00:00:00Z",
                "Status": "running"
            },
            {
                "Component": "grafana",
                "Control": "",
                "InstanceID": "inst-grafana-8cf02503858f6c80",
                "StartTime": "0001-01-01T00:00:00Z",
                "Status": "running"
            },
            {
                "Component": "tidb",
                "Control": "",
                "InstanceID": "inst-tidb-831507a473f4642a",
                "StartTime": "0001-01-01T00:00:00Z",
                "Status": "running"
            },
            {
                "Component": "tidb",
                "Control": "",
                "InstanceID": "inst-tidb-e051a12ac300e1e4",
                "StartTime": "0001-01-01T00:00:00Z",
                "Status": "running"
            }
        ],
        "Version": "v6.5.0"
    },
    "Success": true
}
参数名 示例值 参数类型 参数描述
Data - Object -
Data.Abstract - Object -
Data.Abstract.
ComponentSize
- Object -
Data.Abstract.
ComponentSize.grafana
1 Integer -
Data.Abstract.
ComponentSize.monitor
1 Integer -
Data.Abstract.
ComponentSize.pd
1 Integer -
Data.Abstract.
ComponentSize.tidb
2 Integer -
Data.Abstract.
ComponentSize.tikv
2 Integer -
Data.Abstract.
Resource
- Object -
Data.Abstract.
Resource.CPU
28 Integer -
Data.Abstract.
Resource.Memory
42 Integer -
Data.AccessEntrys - Object -
Data.AccessEntrys.DB - Object -
Data.AccessEntrys.
DB.Description
tidb Access address String -
Data.AccessEntrys.
DB.Host
172.17.0.7 String -
Data.AccessEntrys.
DB.Port
4000 Integer -
Data.AccessEntrys.
DB.Type
mysql String -
Data.AccessEntrys.
DB.UseFor
- String -
Data.AccessEntrys.
Dashboard
- Object -
Data.AccessEntrys.
Dashboard.Description
tidb dashboard String -
Data.AccessEntrys.
Dashboard.Host
172.17.0.7 String -
Data.AccessEntrys.
Dashboard.Port
2379 Integer -
Data.AccessEntrys.
Dashboard.Type
http String -
Data.AccessEntrys.
Dashboard.UseFor
- String -
Data.Alias test String -
Data.Arch aarch64 String -
Data.ClusterID tidb-43bd353978db0af4 String -
Data.Config - Object -
Data.Config.Global - Object -
Data.Config.Global.
MaxReplicas
3 Integer -
Data.Config.Global.
ServerConfigs
- Object -
Data.Config.Global.
ServerConfigs.pd
- Object -
Data.Config.Global.
ServerConfigs.pd.
replication.location-labels
zone Array -
Data.Config.Global.
ServerConfigs.tidb
- Object -
Data.Config.Global.
ServerConfigs.tidb.
binlog.enable
false Boolean -
Data.Config.Global.
ServerConfigs.
tidb.binlog.ignore-error
false Boolean -
Data.Config.Global.
ServerConfigs.tidb.enable-telemetry
false Boolean -
Data.Config.Global.
ServerConfigs.tidb.
log.slow-threshold
400 Integer -
Data.Config.Global.
TiUPOptions
- Object -
Data.Config.Global.
TiUPOptions.GlobalOptions
- Object -
Data.Config.Global.
TiUPOptions.GlobalOptions.SSHPort
22 Integer -
Data.Config.Global.
TiUPOptions.GlobalOptions.User
tidb String -
Data.Config.Global.
TiUPOptions.GlobalOptions.dataDir
/data/data String -
Data.Config.Global.
TiUPOptions.GlobalOptions.deployDir
/data/deploy String -
Data.Config.Global.
Variables
- Object -
Data.Config.Global.
Variables.tidb_distsql_scan_concurrency
15 String -
Data.Control - String -
Data.CreatedAt 2023-09-19T11:50:40.768+08:00 String -
Data.Creator liusx String -
Data.Description - String -
Data.Labels - Object -
Data.Labels.usefor test String -
Data.MetaID 7280379714100684000 Integer -
Data.Model share String -
Data.Platform tiup String -
Data.Status running String -
Data.TaskID - String -
Data.Topology - Array -
Data.Topology.Component pd String -
Data.Topology.Control - String -
Data.Topology.InstanceID inst-pd-ba224b801c4f0935 String -
Data.Topology.StartTime 0001-01-01T00:00:00Z String -
Data.Topology.Status running String -
Data.Version v6.5.0 String -
Success true Boolean -
© 2024 平凯星辰(北京)科技有限公司 all right reserved,powered by GitbookFile Modify: 2024-04-02 15:37:04

results matching ""

    No results matching ""