查询主机信息
接口URL
/api/v1/resource/host?page=1&pageSize=2&key=ID&desc=false&IP=&Spec=&Arch=&Location=&Status=&Stat=&CpuCores=&Memory=
请求方式
GET
Content-Type
application/json
认证方式
Bearer auth
请求Header参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| Accept | application/json | Text | 是 | - |
| Content-Type | application/json | Text | 是 | - |
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| page | 1 | Text | 否 | 页码 |
| pageSize | 2 | Text | 否 | 页面大小 |
| key | ID | Text | 否 | 排序关键字 |
| desc | false | Boolean | 否 | 排序方式，true 为降序，false 为升序 |
| IP | - | String | 否 | IP 地址 |
| Spec | - | String | 否 | 规格名称 |
| Arch | - | String | 否 | CPU 架构 |
| Location | - | String | 否 | 主机位置 |
| Status | - | String | 否 | 主机状态 |
| Stat | - | String | 否 | 主机资源状态 |
| CpuCores | - | Integer | 否 | CPU 核心数量 |
| Memory | - | Integer | 否 | 内存大小 |
成功响应示例
{
"Data": {
"items": [
{
"ID": 1,
"CreatedAt": "2023-09-04T13:00:25.348+08:00",
"UpdatedAt": "2023-09-12T16:40:03.533+08:00",
"DeletedAt": null,
"IP": "172.17.0.2",
"UserName": "root",
"Password": "******",
"HostName": "",
"SSHPort": 22,
"Status": "Online",
"OS": "CentOS Linux 8",
"CpuArch": "aarch64",
"CpuModel": "Kunpeng-920",
"CpuCores": 64,
"Memory": 190,
"Storage": 7375,
"DiskType": "SSD",
"Stat": "InUsed",
"FreeStorage": 7375,
"FreeCpuCores": 60,
"FreeMemory": 182,
"ClusterID": "tidb-64b6c94511d6d05d",
"NodeExporterPort": 9200,
"Location": "",
"Tag": "",
"SpecList": null,
"HostType": "PM",
"Configuration": "64C190G",
"RunningClusters": [
"xinyi_test_0904_01"
],
"RunningComponents": [
"pd"
]
},
{
"ID": 2,
"CreatedAt": "2023-09-04T13:00:37.419+08:00",
"UpdatedAt": "2023-09-12T16:40:03.654+08:00",
"DeletedAt": null,
"IP": "172.17.0.3",
"UserName": "root",
"Password": "******",
"HostName": "",
"SSHPort": 22,
"Status": "Online",
"OS": "CentOS Linux 8",
"CpuArch": "aarch64",
"CpuModel": "Kunpeng-920",
"CpuCores": 64,
"Memory": 190,
"Storage": 7375,
"DiskType": "SSD",
"Stat": "InUsed",
"FreeStorage": 7375,
"FreeCpuCores": 40,
"FreeMemory": 142,
"ClusterID": "tidb-64b6c94511d6d05d",
"NodeExporterPort": 9200,
"Location": "",
"Tag": "",
"SpecList": null,
"HostType": "PM",
"Configuration": "64C190G",
"RunningClusters": [
"xinyi_test_0904_01"
],
"RunningComponents": [
"tidb",
"tikv",
"pd",
"monitor",
"grafana"
]
}
],
"total": 12
},
"Success": true
}
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| Data | - | Object | |
| Data.items | - | Array | |
| Data.items.ID | 1 | Integer | ID 编号 |
| Data.items.CreatedAt | 2023-09-04T13:00:25.348+08:00 | String | 创建时间 |
| Data.items.UpdatedAt | 2023-09-12T16:40:03.533+08:00 | String | 更新时间 |
| Data.items.DeletedAt | null | Null | 删除时间 |
| Data.items.IP | 172.17.0.2 | String | IP 地址 |
| Data.items.UserName | root | String | 用户名 |
| Data.items.Password | ** | String | 密码 |
| Data.items.SSHPort | 22 | Integer | SSH 端口号 |
| Data.items.Status | Online | String | 主机状态 |
| Data.items.OS | CentOS Linux 8 | String | 操作系统 |
| Data.items.CpuArch | aarch64 | String | CPU 架构 [x86_64/aarch64] |
| Data.items.CpuModel | Kunpeng-920 | String | CPU 型号 |
| Data.items.CpuCores | 64 | Integer | CPU 信息数 |
| Data.items.Memory | 190 | Integer | 内存大小 |
| Data.items.Storage | 7375 | Integer | 存储空间，单位 GB |
| Data.items.DiskType | SSD | String | 磁盘类型 [HDD/SSD] |
| Data.items.Stat | InUsed | String | 主机资源状态 |
| Data.items.FreeStorage | 7375 | Integer | 空闲存储容量，单位 GB |
| Data.items.FreeCpuCores | 60 | Integer | 空闲 CPU 核心 |
| Data.items.FreeMemory | 182 | Integer | 空闲内存，单位 GB |
| Data.items.ClusterID | tidb-64b6c94511d6d05d | String | 主机上运行的 TiDB 集群 ID |
| Data.items.Location | - | String | 主机位置 |
| Data.items.Tag | - | String | 主机标签 |
| Data.items.HostType | PM | String | 主机类型 [PM/VM] |
| Data.items.Configuration | 64C190G | String | 主机配置 |
| Data.items.RunningClusters | xinyi_test_0904_01 | Array | 主机上运行的 TiDB 集群名称 |
| Data.items.RunningComponents | pd | Array | 主机上运行的 TiDB 组件名称 |
| Data.total | 12 | Integer | 主机总数 |
| Success | true | Boolean |