查询集群拓扑信息
接口URL
/api/v1/cluster/tidbs/{clusterID}/instances
请求方式
GET
Content-Type
application/json
认证方式
Bearer auth
路径变量
| 参数名 | 示例值 | 参数描述 |
|---|---|---|
| clusterID | tidb-43bd353978db0af4 | 操作的集群ID |
成功响应示例
成功响应示例
{
"Data": [
{
"Arch": "aarch64",
"ClusterID": "tidb-43bd353978db0af4",
"Component": "pd",
"Config": {
"ClientPort": 2379
},
"Control": "",
"CreatedAt": "2023-09-19T11:50:40.765+08:00",
"Creator": "",
"Description": "",
"Host": "172.17.0.7",
"IP": "172.17.0.7",
"InstanceID": "inst-pd-ba224b801c4f0935",
"Labels": {
"host": "172.17.0.7",
"port": "2379"
},
"Location": "",
"Platform": "tiup",
"Port": 2379,
"Resource": {
"CPU": 4,
"Memory": 6
},
"Status": "running",
"Version": "v6.5.0"
},
{
"Arch": "aarch64",
"ClusterID": "tidb-43bd353978db0af4",
"Component": "tikv",
"Config": {
"Port": 20160,
"StatusPort": 20180
},
"Control": "",
"CreatedAt": "2023-09-19T11:50:40.765+08:00",
"Creator": "",
"Description": "",
"Host": "172.17.0.7",
"IP": "172.17.0.7",
"InstanceID": "inst-tikv-c988c96664886ca1",
"Labels": {
"host": "172.17.0.7",
"port": "20160"
},
"Location": "",
"Platform": "tiup",
"Port": 20160,
"Resource": {
"CPU": 4,
"Memory": 6
},
"Status": "running",
"Version": "v6.5.0"
},
{
"Arch": "aarch64",
"ClusterID": "tidb-43bd353978db0af4",
"Component": "tikv",
"Config": {
"Port": 20161,
"StatusPort": 20181
},
"Control": "",
"CreatedAt": "2023-09-19T11:50:40.765+08:00",
"Creator": "",
"Description": "",
"Host": "172.17.0.7",
"IP": "172.17.0.7",
"InstanceID": "inst-tikv-8c3542b231c2c0e1",
"Labels": {
"host": "172.17.0.7",
"port": "20161"
},
"Location": "",
"Platform": "tiup",
"Port": 20161,
"Resource": {
"CPU": 4,
"Memory": 6
},
"Status": "running",
"Version": "v6.5.0"
},
{
"Arch": "aarch64",
"ClusterID": "tidb-43bd353978db0af4",
"Component": "monitor",
"Config": {
"Port": 9090
},
"Control": "",
"CreatedAt": "2023-09-19T11:50:40.765+08:00",
"Creator": "",
"Description": "",
"Host": "172.17.0.7",
"IP": "172.17.0.7",
"InstanceID": "inst-monitor-e2b404521f5f4850",
"Labels": {
"host": "172.17.0.7",
"port": "9090"
},
"Location": "",
"Platform": "tiup",
"Port": 9090,
"Resource": {
"CPU": 4,
"Memory": 6
},
"Status": "running",
"Version": "v6.5.0"
},
{
"Arch": "aarch64",
"ClusterID": "tidb-43bd353978db0af4",
"Component": "grafana",
"Config": {
"Port": 3000
},
"Control": "",
"CreatedAt": "2023-09-19T11:50:40.765+08:00",
"Creator": "",
"Description": "",
"Host": "172.17.0.7",
"IP": "172.17.0.7",
"InstanceID": "inst-grafana-8cf02503858f6c80",
"Labels": {
"host": "172.17.0.7",
"port": "3000"
},
"Location": "",
"Platform": "tiup",
"Port": 3000,
"Resource": {
"CPU": 4,
"Memory": 6
},
"Status": "running",
"Version": "v6.5.0"
},
{
"Arch": "aarch64",
"ClusterID": "tidb-43bd353978db0af4",
"Component": "tidb",
"Config": {
"Port": 4001,
"statusport": 10081
},
"Control": "",
"CreatedAt": "2023-09-19T11:50:40.765+08:00",
"Creator": "",
"Description": "",
"Host": "172.17.0.7",
"IP": "172.17.0.7",
"InstanceID": "inst-tidb-e051a12ac300e1e4",
"Labels": {
"host": "172.17.0.7",
"port": "4001",
"usefor": "olap"
},
"Location": "",
"Platform": "tiup",
"Port": 4001,
"Resource": {
"CPU": 4,
"Memory": 6
},
"Status": "running",
"Version": "v6.5.0"
},
{
"Arch": "aarch64",
"ClusterID": "tidb-43bd353978db0af4",
"Component": "tidb",
"Config": {
"Port": 40010,
"StatusPort": 10091
},
"Control": "",
"CreatedAt": "2023-09-21T16:03:16.206+08:00",
"Creator": "",
"Description": "",
"Host": "172.17.0.6",
"IP": "172.17.0.6",
"InstanceID": "inst-tidb-869858d5024a62a3",
"Labels": {
"host": "172.17.0.6",
"port": "40010"
},
"Location": "",
"Platform": "tiup",
"Port": 40010,
"Resource": {
"CPU": 4,
"Memory": 6
},
"Status": "running",
"Version": "v6.5.0"
}
],
"Success": true
}
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| Data | - | Array | |
| Data.Arch | aarch64 | String | 计算平台架构 |
| Data.ClusterID | tidb-43bd353978db0af4 | String | 集群ID, 集群的全局唯一编号 |
| Data.Component | pd | String | |
| Data.Config | - | Object | |
| Data.Config.ClientPort | 2379 | Integer | |
| Data.Control | - | String | |
| Data.CreatedAt | 2023-09-19T11:50:40.765+08:00 | String | |
| Data.Creator | - | String | |
| Data.Description | - | String | |
| Data.Host | 172.17.0.7 | String | |
| Data.IP | 172.17.0.7 | String | |
| Data.InstanceID | inst-pd-ba224b801c4f0935 | String | |
| Data.Labels | - | Object | 自定义标签 |
| Data.Labels.host | 172.17.0.7 | String | |
| Data.Labels.port | 2379 | String | |
| Data.Location | - | String | |
| Data.Platform | tiup | String | 控制平台，支持tiup或kubernetes |
| Data.Port | 2379 | Integer | |
| Data.Resource | - | Object | |
| Data.Resource.CPU | 4 | Integer | |
| Data.Resource.Memory | 6 | Integer | |
| Data.Status | running | String | 数据库节点状态 |
| Data.Version | v6.5.0 | String | 集群版本 |
| Success | true | Boolean |