From 26e484a8d25003b57e62ea29e4fd270710da00f3 Mon Sep 17 00:00:00 2001 From: Akkia Date: Fri, 20 May 2022 11:15:20 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0API=E7=A4=BA=E4=BE=8B?= =?UTF-8?q?=E4=BB=A5=E5=8C=B9=E9=85=8D=E4=B8=8A=E6=B8=B8=E6=9B=B4=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/guide/api.md | 94 +++++++++++++++++++++++++++++++++++++---------- 1 file changed, 74 insertions(+), 20 deletions(-) diff --git a/docs/guide/api.md b/docs/guide/api.md index ed36a211..e3f8602d 100644 --- a/docs/guide/api.md +++ b/docs/guide/api.md @@ -4,8 +4,12 @@ Token认证方式: Request Headers: Authorization: Token ``` -获取服务器列表:`GET /api/v1/server/list?tag=` +下面示例中的负数时间戳为(0000-00-00) +目前表示面板上线后该服务器从未汇报过 +但不建议用正负性判断状态 + +获取服务器列表:`GET /api/v1/server/list?tag=` query: tag (ServerTag 提供此参数则仅查询该分组下的服务器) ``` { @@ -14,11 +18,21 @@ query: tag (ServerTag 提供此参数则仅查询该分组下的服务器) "result": [ { "id": 1, - "name": "ServerName", - "tag": "ServerTag", + "name": "Server1", + "tag": "Tag1", + "last_active": 1653014667, "ipv4": "1.1.1.1", "ipv6": "", "valid_ip": "1.1.1.1" + }, + { + "id": 2, + "name": "Server2", + "tag": "Tag2", + "last_active": -62135596800, + "ipv4": "", + "ipv6": "", + "valid_ip": "" } ] } @@ -34,8 +48,9 @@ query: tag (ServerTag 提供此参数则仅查询该分组下的服务器) "result": [ { "id": 1, - "name": "ServerName", - "tag": "ServerTag", + "name": "Server1", + "tag": "Tag1", + "last_active": 1653015042, "ipv4": "1.1.1.1", "ipv6": "", "valid_ip": "1.1.1.1", @@ -55,23 +70,62 @@ query: tag (ServerTag 提供此参数则仅查询该分组下的服务器) "Version": "" }, "status": { - "CPU": 10.94117647050606, - "MemUsed": 14150975488, + "CPU": 17.330210772540017, + "MemUsed": 14013841408, "SwapUsed": 0, - "DiskUsed": 2138323378176, - "NetInTransfer": 652628744, - "NetOutTransfer": 465447325, - "NetInSpeed": 2156, - "NetOutSpeed": 4254, - "Uptime": 157738, - "Load1": 3.82373046875, - "Load5": 3.74169921875, - "Load15": 4.5966796875, - "TcpConnCount": 214, - "UdpConnCount": 48, - "ProcessCount": 451 + "DiskUsed": 2335048912896, + "NetInTransfer": 2710273234, + "NetOutTransfer": 695454765, + "NetInSpeed": 10806, + "NetOutSpeed": 5303, + "Uptime": 331080, + "Load1": 5.23486328125, + "Load5": 4.873046875, + "Load15": 3.99267578125, + "TcpConnCount": 195, + "UdpConnCount": 70, + "ProcessCount": 437 + } + }, + { + "id": 2, + "name": "Server2", + "tag": "Tag2", + "last_active": -62135596800, + "ipv4": "", + "ipv6": "", + "valid_ip": "", + "host": { + "Platform": "", + "PlatformVersion": "", + "CPU": null, + "MemTotal": 0, + "DiskTotal": 0, + "SwapTotal": 0, + "Arch": "", + "Virtualization": "", + "BootTime": 0, + "CountryCode": "", + "Version": "" + }, + "status": { + "CPU": 0, + "MemUsed": 0, + "SwapUsed": 0, + "DiskUsed": 0, + "NetInTransfer": 0, + "NetOutTransfer": 0, + "NetInSpeed": 0, + "NetOutSpeed": 0, + "Uptime": 0, + "Load1": 0, + "Load5": 0, + "Load15": 0, + "TcpConnCount": 0, + "UdpConnCount": 0, + "ProcessCount": 0 } } ] } -```` +```