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":{},"headers":[],"relativePath":"en_US/guide/api.md","filePath":"en_US/guide/api.md","lastUpdated":1698335020000}'),t={name:"en_US/guide/api.md"},e=o(`<p><strong>Nezha Monitoring now supports querying the status information of the Agent in the Dashboard using the API</strong></p><h2 id="create-token" tabindex="-1">Create Token <a class="header-anchor" href="#create-token" aria-label="Permalink to "Create Token""></a></h2><p>API allows Token authentication method and Cookies authentication method<br> To create a new Token, after entering the admin panel, click on the avatar in the upper right corner and select "API Token" to enter the Token management page<br> Click "Add Token" and after customizing the notes, click "Add"<br> To delete a Token, please select the corresponding Token and click the delete icon on the right</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Token is the authentication tool of API, it is very important for your Dashboard's information security, please don't leak your Token to others</p></div><h2 id="authentication-method" tabindex="-1">Authentication method <a class="header-anchor" href="#authentication-method" aria-label="Permalink to "Authentication method""></a></h2><p>Token authentication method:</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="how-to-use" tabindex="-1">How to use <a class="header-anchor" href="#how-to-use" aria-label="Permalink to "How to use""></a></h2><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>The negative timestamp in the example below is (0000-00-00)<br> It is currently used to indicate that the Agent has never reported since the Dashboard went live<br> However, it is not recommended to use positivity or negativity to determine the status</p></div><div class="tip custom-block"><p class="custom-block-title">TIP</p><p><strong>The request method is <code>Get</code> and the return format is <code>JSON</code>.</strong></p></div><ul><li>Get a list of servers: <code>GET /api/v1/server/list?tag=</code><br> query: tag (ServerTag means the group of servers, if this value is provided, only the servers in this group are queried)</li></ul><p>JSON Return Example:</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>Get server details: <code>GET /api/v1/server/details?id=&tag=</code><br> query: id (ServerID. Multiple IDs are separated by commas, provide this value to query the server corresponding to the ID, while ignoring the tag value)<br> query: tag (ServerTag, if this value is provided, only the servers in this group are queried)</li></ul><p>JSON Return Example:</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),l=[e];function p(u,c,i,r,q,C){return n(),a("div",null,l)}const d=s(t,[["render",p]]);export{y as __pageData,d as default};
|