111 lines
14 KiB
JavaScript
111 lines
14 KiB
JavaScript
import{_ as s,o as n,c as a,R as o}from"./chunks/framework.44fd0451.js";const y=JSON.parse('{"title":"","description":"","frontmatter":{"outline":"deep"},"headers":[],"relativePath":"guide/api.md","filePath":"guide/api.md","lastUpdated":1708788229000}'),l={name:"guide/api.md"},p=o(`<p><strong>哪吒面板现在已经支持使用 API 接口查询面板中 Agent 的状态信息</strong></p><h2 id="创建-token" tabindex="-1">创建 Token <a class="header-anchor" href="#创建-token" aria-label="Permalink to "创建 Token""></a></h2><p>哪吒面板的 API 接口允许使用 Token 认证与 Cookies 认证<br> 要新建一个 Token，在进入管理面板后，点击右上角的头像，选择 “API Token”，进入 Token 管理页面<br> 点击 “添加 Token”，自定义备注后，点击 “添加”<br> 如需删除一个 Token，请选择相应的 Token，点击右侧的删除图标</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Token 是 API 接口的鉴权工具，它对你的面板的信息安全非常重要，请不要泄漏你的 Token 给他人</p></div><h2 id="认证方式" tabindex="-1">认证方式 <a class="header-anchor" href="#认证方式" aria-label="Permalink to "认证方式""></a></h2><p>Token 认证方式：</p><div class="language-"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#A6ACCD;">Request Headers: </span></span>
|
||
<span class="line"><span style="color:#A6ACCD;">Authorization: Token</span></span></code></pre></div><h2 id="使用说明" tabindex="-1">使用说明 <a class="header-anchor" href="#使用说明" aria-label="Permalink to "使用说明""></a></h2><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>下面示例中的负数时间戳为（0000-00-00）<br> 目前表示 Dashboard 上线后该 Agent 从未汇报过<br> 但不建议用正负性判断状态</p></div><div class="tip custom-block"><p class="custom-block-title">TIP</p><p><strong>请求方式为 <code>Get</code>，返回格式为 <code>JSON</code></strong></p></div><ul><li>获取服务器列表：<code>GET /api/v1/server/list?tag=</code><br> query: tag (ServerTag 是服务器的分组，提供此参数则仅查询该分组中的服务器)</li></ul><p>JSON 返回示例：</p><div class="language-"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#A6ACCD;">{</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "code": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "message": "success",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "result": [</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> {</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "id": 1,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "name": "Server1",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "tag": "Tag1",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "last_active": 1653014667,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "ipv4": "1.1.1.1",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "ipv6": "",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "valid_ip": "1.1.1.1"</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> },</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> {</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "id": 2,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "name": "Server2",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "tag": "Tag2",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "last_active": -62135596800,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "ipv4": "",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "ipv6": "",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "valid_ip": ""</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> }</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> ]</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;">}</span></span></code></pre></div><ul><li>获取服务器详情：<code>GET /api/v1/server/details?id=&tag=</code><br> query: id (ServerID 多个 ID 以逗号分隔，提供此参数则查询该 ID 对应的服务器，同时无视tag参数)<br> query: tag (ServerTag 提供此参数则仅查询该分组下的服务器)</li></ul><p>JSON 返回示例：</p><div class="language-"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#A6ACCD;">{</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "code": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "message": "success",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "result": [</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> {</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "id": 1,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "name": "Server1",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "tag": "Tag1",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "last_active": 1653015042,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "ipv4": "1.1.1.1",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "ipv6": "",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "valid_ip": "1.1.1.1",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "host": {</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Platform": "darwin",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "PlatformVersion": "12.3.1",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "CPU": [</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Apple M1 Pro 1 Physical Core"</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> ],</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "MemTotal": 17179869184,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "DiskTotal": 2473496842240,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "SwapTotal": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Arch": "arm64",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Virtualization": "",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "BootTime": 1652683962,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "CountryCode": "hk",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Version": ""</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> },</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "status": {</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "CPU": 17.330210772540017,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "MemUsed": 14013841408,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "SwapUsed": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "DiskUsed": 2335048912896,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "NetInTransfer": 2710273234,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "NetOutTransfer": 695454765,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "NetInSpeed": 10806,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "NetOutSpeed": 5303,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Uptime": 331080,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Load1": 5.23486328125,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Load5": 4.873046875,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Load15": 3.99267578125,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "TcpConnCount": 195,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "UdpConnCount": 70,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "ProcessCount": 437</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> }</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> },</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> {</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "id": 2,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "name": "Server2",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "tag": "Tag2",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "last_active": -62135596800,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "ipv4": "",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "ipv6": "",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "valid_ip": "",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "host": {</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Platform": "",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "PlatformVersion": "",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "CPU": null,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "MemTotal": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "DiskTotal": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "SwapTotal": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Arch": "",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Virtualization": "",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "BootTime": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "CountryCode": "",</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Version": ""</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> },</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "status": {</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "CPU": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "MemUsed": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "SwapUsed": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "DiskUsed": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "NetInTransfer": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "NetOutTransfer": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "NetInSpeed": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "NetOutSpeed": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Uptime": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Load1": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Load5": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "Load15": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "TcpConnCount": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "UdpConnCount": 0,</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> "ProcessCount": 0</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> }</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> }</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;"> ]</span></span>
|
||
<span class="line"><span style="color:#A6ACCD;">}</span></span></code></pre></div>`,16),t=[p];function e(c,u,q,C,A,i){return n(),a("div",null,t)}const D=s(l,[["render",e]]);export{y as __pageData,D as default};
|