更新API中文文档
This commit is contained in:
parent
cf55d7c2d6
commit
4ce36ebdc5
@ -1,16 +1,33 @@
|
|||||||
## API接口(允许使用API Token认证与Cookies认证)
|
**哪吒面板现在已经支持使用API接口查询面板中Agent的状态信息**
|
||||||
|
|
||||||
|
## 创建Token
|
||||||
|
哪吒面板的API接口允许使用Token认证与Cookies认证
|
||||||
|
要新建一个Token,在进入管理面板后,点击右上角的头像,选择 “API Token”,进入Token管理页面
|
||||||
|
点击 “添加Token”,自定义备注后,点击 “添加”
|
||||||
|
如需删除一个Token,请选择相应的Token,点击右侧的删除图标
|
||||||
|
::: warning
|
||||||
|
Token是API接口的鉴权工具,它对你的面板的信息安全非常重要,请不要泄漏你的Token给他人
|
||||||
|
:::
|
||||||
|
|
||||||
|
## 认证方式
|
||||||
Token认证方式:
|
Token认证方式:
|
||||||
```
|
```
|
||||||
Request Headers:
|
Request Headers:
|
||||||
Authorization: Token
|
Authorization: Token
|
||||||
```
|
```
|
||||||
|
## 使用说明
|
||||||
|
::: warning
|
||||||
下面示例中的负数时间戳为(0000-00-00)
|
下面示例中的负数时间戳为(0000-00-00)
|
||||||
目前表示面板上线后该服务器从未汇报过
|
目前表示面板上线后该服务器从未汇报过
|
||||||
但不建议用正负性判断状态
|
但不建议用正负性判断状态
|
||||||
|
:::
|
||||||
|
::: tip
|
||||||
|
**请求方式为 `Get`,返回格式为 `JSON`**
|
||||||
|
:::
|
||||||
|
+ 获取服务器列表:`GET /api/v1/server/list?tag=`
|
||||||
|
query: tag (ServerTag是服务器的分组,提供此参数则仅查询该分组下的服务器)
|
||||||
|
|
||||||
获取服务器列表:`GET /api/v1/server/list?tag=`
|
JSON返回示例:
|
||||||
query: tag (ServerTag 提供此参数则仅查询该分组下的服务器)
|
|
||||||
```
|
```
|
||||||
{
|
{
|
||||||
"code": 0,
|
"code": 0,
|
||||||
@ -36,11 +53,13 @@ query: tag (ServerTag 提供此参数则仅查询该分组下的服务器)
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
获取服务器详情:`GET /api/v1/server/details?id=&tag=`
|
+ 获取服务器详情:`GET /api/v1/server/details?id=&tag=`
|
||||||
query: id (ServerID 以逗号分隔 提供此参数则查询该列表对应的服务器 同时无视tag参数)
|
query: id (ServerID 多个ID以逗号分隔,提供此参数则查询该列表对应的服务器,同时无视tag参数)
|
||||||
query: tag (ServerTag 提供此参数则仅查询该分组下的服务器)
|
query: tag (ServerTag 提供此参数则仅查询该分组下的服务器)
|
||||||
|
|
||||||
|
JSON返回示例:
|
||||||
```
|
```
|
||||||
{
|
{
|
||||||
"code": 0,
|
"code": 0,
|
||||||
|
Loading…
x
Reference in New Issue
Block a user