仰望星辰工作室

better-staridc-MNBT

better-staridc-MNBT/ docs/api/admin.md 10.4 KB · 247 行 原始文件
Z zfhsh first commit 1 天前
1---
2title: 后台管理接口
3description: admin/ajax.php 后台管理 AJAX 接口（登录、宝塔节点、主机管理、一键部署、订单、系统设置等）
4---
5
6# 后台管理接口（admin/ajax.php）
7
8**入口**：`POST /admin/ajax.php`
9**鉴权**：除 `gn=login` 外，全部需要管理员登录（`admin_token` Cookie）。
10**路由文件**：admin/ajax.php → admin/api/*.php
11
12## 2.1 登录与系统信息
13
14### `gn=login` —— 管理员登录
15
16| 项 | 值 |
17|----|----|
18| 文件 | admin/api/login.php |
19| 鉴权 | 公开 |
20| 参数 | `user`、`pass`、`code`（验证码，可选） |
21| 返回 | `{"code":"登陆成功"}`，并写入 `admin_token` Cookie |
22
23### `gn=system_info` —— 系统信息
24
25| 项 | 值 |
26|----|----|
27| 文件 | admin/api/gg.php |
28| 参数 | 无 |
29| 返回字段 | `hosts`、`bt_panels`、`nodes`、`orders`、`os`、`hostname`、`php_version`、`php_sapi`、`server_soft`、`server_ip`、`server_port`、`server_time`、`timezone`、`memory_limit`、`max_exec_time`、`upload_max`、`post_max`、`ext_count`、`disk_total`、`disk_free`、`disk_used`、`disk_pct`、`mem_current`、`mem_peak`、`load_avg`、`db_version`、`web_version`、`sql_version` |
30
31### `gn=gglist` —— 公告列表
32
33返回系统公告 JSON 数组。
34
35### `gn=update` —— 在线系统更新
36
37| 项 | 值 |
38|----|----|
39| 参数 | 无 |
40| 返回 | `{"code":"...", "msg":"..."}` |
41
42---
43
44## 2.2 宝塔节点管理（bt）
45
46文件：admin/api/bt.php
47
48| `gn` | 功能 | 必需参数 | 返回要点 |
49|------|------|----------|----------|
50| `listbt` | 宝塔列表（分页） | `page`、`limit`、`sort`、`sortOrder` | `total`、`rows[]` |
51| `addbt` | 添加宝塔节点 | `ip`、`dk`、`key`、`bh`、`btos`、`urlla`、`ftpdz`、`xieyi`、`kg` | `code`、`msg` |
52| `btsj` | 获取宝塔详情 | `id` | `code`、`ip`、`dk`、`my`、`kg`、`btos` |
53| `xgjl` | 修改宝塔信息 | `id`、`ip`、`dk`、`key`、`kg`、`btos`、`urlla`、`ftpdz`、`xieyi` | `code`、`msg` |
54| `btsc` | 删除宝塔 | `id` | `code`、`msg` |
55| `btztjc` | 检测连接状态 | `btid` | `qk`、`code`、`titco` |
56| `mnbt` | 获取系统版本 | 无 | `cl`、`gx`、`vs`、`gg` |
57| `list_node_php` | 获取节点 PHP 版本列表 | `btdh` | `qk`、`versions`、`latest`、`current_default` |
58| `auto_detect_node_php` | 自动检测节点 PHP | `btdh` | `qk`、`version`、`msg` |
59| `set_node_php` | 设置节点默认 PHP | `btdh`、`version` | `qk`、`msg` |
60
61**参数说明：**
62
63- `btos`：操作系统（`1`=Linux，`0`=Windows）
64- `xieyi`：协议（`http`/`https`）
65- `btdh` / `bh`：宝塔节点编号
66
67---
68
69## 2.3 主机管理（zj）
70
71文件：admin/api/zj.php
72
73| `gn` | 功能 | 必需参数 | 返回要点 |
74|------|------|----------|----------|
75| `listzj` | 主机列表（分页） | `page`、`limit`、`sort`、`sortOrder`、`where`（可选） | `total`、`rows[]` |
76| `addzj` | 添加主机 | `btdh`、`user`、`pass`、`datae`、`webkj`、`sqlkj`、`ll`、`ymbds`、`kg` | `code`、`msg` |
77| `zjxgjl` | 修改主机配置 | `id`、`user`、`pass`、`sqluser`、`sqlpass`、`ymbds`、`datar`、`webkj`、`sqlkj`、`llmax`、`kg` | `code`、`msg` |
78| `zjsc` | 删除主机 | `id` | `code`、`msg` |
79| `zjscxz` | 批量删除主机 | `idsz`（数组） | `code`、`msg` |
80
81**参数说明：**
82
83- `datae`/`datar`：到期日期（`Y-m-d`，`0000-00-00` 表示永久）
84- `webkj`/`sqlkj`/`llmax`：网页空间、数据库空间、流量上限（单位 MB）
85- `ymbds`：域名绑定数
86
87---
88
89## 2.4 一键部署程序（cx）
90
91文件：admin/api/cx.php
92
93| `gn` | 功能 | 必需参数 | 返回要点 |
94|------|------|----------|----------|
95| `listbs` | 部署程序列表 | `page`、`limit`、`sort`、`sortOrder` | `total`、`rows[]` |
96| `cxtj` | 添加部署程序 | `cxname`、`cxjs`、`cxrmb`、`cxwebkj`、`cxsqlkj`、`alerts`、`kg`、`filecx`、`imgfile`、`czf`、`bdf` | `code`、`msg` |
97| `cxxgjl` | 修改部署程序 | `id`、`cxname`、`cxjc`、`webkj`、`sqlkj`、`cxrmb`、`alerts`、`cxkg`、`czf`、`bdf` | `code`、`msg` |
98| `cxsc` | 删除部署程序 | `id` | `code`、`msg` |
99| `cxscxz` | 批量删除 | `idsz` | `code`、`msg` |
100| `cxdc` | 导出部署程序 | `id`（多个用 `,` 分隔） | `code`、`msg` |
101| `cxfiledru` | 导入部署程序（分片上传） | `fesw`、`zsize`、`file` | `error`、`size`、`msg` |
102
103**字段说明：**
104
105- `czf`：安装配置（JSON，部署引擎脚本）
106- `bdf`：安装前表单填写配置（JSON）
107- `alerts`：部署完成后的提示文案
108
109---
110
111## 2.5 订单管理（dd）
112
113文件：admin/api/dd.php
114
115| `gn` | 功能 | 必需参数 | 返回要点 |
116|------|------|----------|----------|
117| `listdd` | 订单列表（分页） | `page`、`limit`、`sort`、`sortOrder` | `total`、`rows[]` |
118| `ddsc` | 删除订单 | `id` | `code`、`msg` |
119| `ddscxz` | 批量删除订单 | `idsz` | `code`、`msg` |
120
121---
122
123## 2.6 系统公告与更新（gg）
124
125文件：admin/api/gg.php
126
127| `gn` | 功能 | 必需参数 | 返回要点 |
128|------|------|----------|----------|
129| `system_info` | 系统信息 | 无 | 见 [2.1 登录与系统信息](#21-登录与系统信息) |
130| `gglist` | 公告列表 | 无 | 公告 JSON |
131| `update` | 系统更新 | 无 | `code`、`msg` |
132
133---
134
135## 2.7 操作日志（log）
136
137文件：admin/api/log.php
138
139| `gn` | 功能 | 必需参数 | 返回要点 |
140|------|------|----------|----------|
141| `listlog` | 日志列表（分页/搜索） | `page`、`limit`、`sort`、`sortOrder`、`where` | `total`、`rows[]` |
142| `logsc` | 删除日志 | `id` | `code`、`msg` |
143| `logscxz` | 批量删除日志 | `idsz` | `code`、`msg` |
144| `logclear` | 清空全部日志 | 无 | `code`、`msg` |
145
146**日志字段：** `czuser`（操作用户）、`date`（时间）、`lx`（类型）、`lr`（内容）、`ip`、`qk`（情况）。
147
148---
149
150## 2.8 MNBT 节点管理（node）
151
152文件：admin/api/node.php
153
154### 节点 CRUD
155
156| `gn` | 功能 | 必需参数 | 返回要点 |
157|------|------|----------|----------|
158| `listnode` | 节点列表 | `page`、`limit`、`sort`、`sortOrder`、`keyword`、`status` | `total`、`rows[]` |
159| `addnode` | 添加节点 | `bt_id`、`node_name`、`node_id`、`interval_seconds` | `success`、`code`、`msg`、`id`、`node_id`、`config`、`config_json` |
160| `delnode` | 删除节点 | `id` | `success`、`code`、`msg` |
161| `setnodestatus` | 启用/禁用节点 | `id`、`enabled` | `success`、`code`、`msg` |
162| `nodeconfig` | 获取节点配置 | `id` | `success`、`code`、`msg`、`config`、`config_json` |
163| `nodeping` | 发起 Ping 任务 | `id` | `success`、`code`、`msg`、`task_id` |
164| `nodestats` | 节点统计 | 无 | `success`、`code`、`msg`、`data` |
165
166### 违禁词扫描
167
168| `gn` | 功能 | 必需参数 | 返回要点 |
169|------|------|----------|----------|
170| `nodeforbiddenscan` | 发起扫描任务 | `id`、`root`、`keywords`、`site`、`max_file_size_mb`、`max_matches` | `success`、`code`、`msg`、`task_id` |
171| `listforbiddenscan` | 扫描结果列表 | `page`、`limit`、`sort`、`sortOrder`、`node_pk`、`time_filter`、`status_filter` | `total`、`rows[]` |
172| `listforbiddenmatch` | 命中记录列表 | `page`、`limit`、`task_id` | `total`、`rows[]` |
173| `get_global_keywords` | 获取全局违禁词 | 无 | `success`、`code`、`msg`、`data` |
174| `savescancfg` | 保存扫描配置 | `skg`、`snr`、`sgbfx`、`sml`、`stqml`、`stqhz`、`sdzmax`、`sdhmax`、`sqzcskg`、`sqzcs` | `success`、`code`、`msg` |
175| `clearoldscans` | 清理旧扫描 | `days` | `success`、`code`、`msg`、`deleted_scans`、`deleted_matches`、`deleted_tasks` |
176
177**`time_filter` 枚举：** `today`、`yesterday`、`week`、`month`
178**`status_filter` 枚举：** `success`、`failed`、`has_matches`
179
180### 节点任务
181
182| `gn` | 功能 | 必需参数 | 返回要点 |
183|------|------|----------|----------|
184| `listnodetask` | 节点任务列表 | `page`、`limit`、`sort`、`sortOrder`、`node_pk`、`status`、`action` | `total`、`rows[]` |
185
186### 节点日志
187
188| `gn` | 功能 | 必需参数 | 返回要点 |
189|------|------|----------|----------|
190| `nodeloglist` | 日志文件列表 | `node_id` | `success`、`code`、`msg`、`data`、`total_count` |
191| `nodelogcontent` | 读取日志内容 | `node_id`、`log_file`、`offset`、`limit`、`keyword`、`level` | `success`、`code`、`msg`、`data`、`total_lines`、`file_size`、`current_offset`、`has_more` |
192| `nodelogclear` | 清空日志文件 | `node_id`、`log_file` | `success`、`code`、`msg` |
193| `nodeloglevel` | 设置日志级别 | `node_id`、`level`（DEBUG/INFO/WARNING/ERROR） | `success`、`code`、`msg`、`level`、`available_levels` |
194| `nodelogstats` | 日志统计 | `node_id`、`log_file` | `success`、`code`、`msg`、`data` |
195
196### 站点统计
197
198| `gn` | 功能 | 必需参数 | 返回要点 |
199|------|------|----------|----------|
200| `reset_sitestats` | 重置站点统计 | `node_id`、`site` | `success`、`code`、`msg`、`deleted` |
201
202---
203
204## 2.9 系统设置（setting）
205
206文件：admin/api/setting.php
207
208| `gn` | 功能 | 必需参数 | 返回要点 |
209|------|------|----------|----------|
210| `setwz` | 修改网站设置 | `gg`、`qq`、`yzm`、`zjyx` | `code`、`msg` |
211| `setapi` | 修改 API 设置 | `apikey`、`apiqk`、`linux`、`windows` | `code`、`msg` |
212| `setkzmb` | 修改控制面板 | `name`、`ftp`、`yzm`、`kg`、`bq`、`loa`、`lob`、`loc` | `code`、`msg` |
213| `setpaymethods` | 设置支付方式 | `methods`（JSON） | `code`、`msg` |
214| `gl` | 修改管理员账户 | `yuser`、`ypass`、`xuser`、`xpass` | `code`、`msg` |
215| `mailmode` | 邮箱配置 | `host`、`user`、`password`、`port` | `code`、`msg` |
216| `jkscsz` | 监控/违禁词扫描设置 | `ymkg`、`ymyjkg`、`ymtsyz`、`wjkg`、`wjyjkg`、`wjtsyz`、`option` | `code`、`msg` |
217| `settheme` | 切换主题 | `usertheme`、`admintheme` | `code`、`msg` |
218
219---
220
221## 2.10 系统修复（repair）
222
223文件：admin/api/repair.php
224
225| `gn` | 功能 | 必需参数 | 返回要点 |
226|------|------|----------|----------|
227| `xtxf` | 系统修复 | `xx`（修复选项）、`xe`（版本标识） | `code`、`msg` |
228
229---
230
231## 2.11 插件管理（plugin）
232
233文件：admin/api/plugin.php
234
235| `gn` | 功能 | 必需参数 | 返回要点 |
236|------|------|----------|----------|
237| `plugin_list` | 插件列表 | 无 | `total`、`rows[]` |
238| `plugin_install` | 安装插件 | `slug` | `code`、`msg` |
239| `plugin_enable` | 启用/禁用插件 | `slug`、`enabled` | `code`、`msg` |
240| `plugin_uninstall` | 卸载插件 | `slug` | `code`、`msg` |
241
242---
243
244**相关文档：**
245
246- [API 通用约定](./overview.md)
247- [用户控制面板接口](./user.md)