查询节点列表
此接口用于按条件查询节点列表信息。
接口描述
通信协议：HTTP
URL：GET /api/v1/node
传参方式：query
请求参数
| 字段名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| pageNum | number | 是 | 当前页码数 |
| pageSize | number | 是 | 每页的节点个数，如果设为 -1 则返回所有数据 |
| name | string | 否 | 节点名称 |
| basicInfo | boolean | 否 | 是否返回基本信息，默认为 false 不返回 |
响应参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| list | List[ ] | 节点数据 |
| total | number | 总条数 |
| pageNum | number | 当前页数 |
| pageSize | number | 每页数量 |
List
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | string | 节点主键 |
| address | string | 节点地址 |
| name | string | 节点名称 |
| status | string | 节点状态。online 表示在线；offline 表示离线 |
| type | string | 节点类型，如 Linux、Sylixos、Edgeros 等 |
| tls | boolean | 是否使用 TLS 加密 |
| containerTotal | number | 容器总数量 |
| containerRunning | number | 实际运行的容器数量。stop、pause 等状态的容器也加入计算 |
| containerEcsmTotal | number | ECSM 管理的容器总数 |
| containerEcsmRunning | number | ECSM 管理的运行中容器数量 |
| upTime | number | 运行时长 |
| createdTime | string | 节点创建时间，格式为 yyyy-MM-dd HH:mm:ss |
| arch | string | 节点架构 |
请求示例
curl --location --request GET 'http://localhost:3001/api/v1/node?pageNum=1&pageSize=10&name='
响应示例
{
"status": 200,
"message": "success",
"fieldErrors": null,
"data": {
"list": [
{
"id": "af2eb355-a8ca-4023-8e3b-7efe7d4a9c47",
"name": "192.168.XX.XX",
"type": "linux",
"arch": "x86-64",
"tls": false,
"createdTime": "2023-01-05 14:11:16",
"status": "online",
"address": "192.168.XX.XX:1112",
"containerTotal": 3,
"containerRunning": 3,
"containerEcsmTotal": 3,
"containerEcsmRunning": 3,
"eapTotal": 0,
"eapRunning": 0,
"upTime": 2001246.12
},
{
"id": "1a7dd37b-378c-44b7-b89e-01b73f9acec0",
"name": "192.168.XX.XX",
"type": "sylixos",
"arch": "ppc",
"tls": false,
"createdTime": "2022-12-28 11:37:00",
"status": "offline",
"address": "192.168.XX.XX:1112",
"containerTotal": 21,
"containerRunning": 0,
"containerEcsmTotal": 21,
"containerEcsmRunning": 0,
"eapTotal": 0,
"eapRunning": 0,
"upTime": 0
}
],
"pageNum": 1,
"pageSize": 10,
"total": 2
}
}
// curl --location --request GET 'http://localhost:3001/api/v1/node?pageNum=1&pageSize=10&name=&basicInfo=true'
{
"status": 200,
"message": "success",
"fieldErrors": null,
"data": {
"list": [
{
"id": "1a7dd37b-378c-44b7-b89e-01b73f9acec0",
"name": "192.168.XX.XX",
"type": "sylixos",
"arch": "ppc"
},
{
"id": "af2eb355-a8ca-4023-8e3b-7efe7d4a9c47",
"name": "192.168.XX.XX",
"type": "linux",
"arch": "x86-64"
}
],
"pageNum": 1,
"pageSize": 10,
"total": 2
}
}
错误码
具体请参见 错误码说明。
京公网安备11010802043204号