KJZH001/nezhahq.github.io
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

更新API示例以匹配上游更改

Browse Source
This commit is contained in:
Akkia 2022-05-20 11:15:20 +08:00 committed by GitHub
parent ffd44a68a1
commit 26e484a8d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 74 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
docs/guide/api.md
View File

@ -4,8 +4,12 @@ Token认证方式：
Request Headers: Request Headers:
Authorization: Token Authorization: Token
``` ```
获取服务器列表：`GET /api/v1/server/list?tag=`
下面示例中的负数时间戳为（0000-00-00）
目前表示面板上线后该服务器从未汇报过
但不建议用正负性判断状态
获取服务器列表：`GET /api/v1/server/list?tag=`
query: tag (ServerTag 提供此参数则仅查询该分组下的服务器) query: tag (ServerTag 提供此参数则仅查询该分组下的服务器)
``` ```
{ {
@ -14,11 +18,21 @@ query: tag (ServerTag 提供此参数则仅查询该分组下的服务器)
"result": [ "result": [
{ {
"id": 1, "id": 1,
"name": "ServerName", "name": "Server1",
"tag": "ServerTag", "tag": "Tag1",
"last_active": 1653014667,
"ipv4": "1.1.1.1", "ipv4": "1.1.1.1",
"ipv6": "", "ipv6": "",
"valid_ip": "1.1.1.1" "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": [ "result": [
{ {
"id": 1, "id": 1,
"name": "ServerName", "name": "Server1",
"tag": "ServerTag", "tag": "Tag1",
"last_active": 1653015042,
"ipv4": "1.1.1.1", "ipv4": "1.1.1.1",
"ipv6": "", "ipv6": "",
"valid_ip": "1.1.1.1", "valid_ip": "1.1.1.1",
@ -55,23 +70,62 @@ query: tag (ServerTag 提供此参数则仅查询该分组下的服务器)
"Version": "" "Version": ""
}, },
"status": { "status": {
"CPU": 10.94117647050606, "CPU": 17.330210772540017,
"MemUsed": 14150975488, "MemUsed": 14013841408,
"SwapUsed": 0, "SwapUsed": 0,
"DiskUsed": 2138323378176, "DiskUsed": 2335048912896,
"NetInTransfer": 652628744, "NetInTransfer": 2710273234,
"NetOutTransfer": 465447325, "NetOutTransfer": 695454765,
"NetInSpeed": 2156, "NetInSpeed": 10806,
"NetOutSpeed": 4254, "NetOutSpeed": 5303,
"Uptime": 157738, "Uptime": 331080,
"Load1": 3.82373046875, "Load1": 5.23486328125,
"Load5": 3.74169921875, "Load5": 4.873046875,
"Load15": 4.5966796875, "Load15": 3.99267578125,
"TcpConnCount": 214, "TcpConnCount": 195,
"UdpConnCount": 48, "UdpConnCount": 70,
"ProcessCount": 451 "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
} }
} }
] ]
} }
```` ```