文档
Web 安全、防火墙与日志 API
RustMinerSystem 安全路径、Web 端口、HTTPS、证书、IP/钱包防火墙和日志查询接口。
Web 安全、防火墙与日志 API
本章包含可能导致后台地址变化、服务重启或访问被阻断的接口。调用前必须确认新地址可访问,并避免把当前管理端 IP 加入黑名单。
Web 访问设置
| 方法 | 路径 | 请求/用途 |
|---|---|---|
| GET | /api/route |
获取安全访问路径。 |
| POST | /api/route |
保存安全路径,主体为 { "k": "new-route" }。 |
| POST | /api/web/port/restart |
修改 Web 端口,主体为 { "port": 8080 }。 |
| GET | /api/web/tls |
获取后台 HTTPS 状态。 |
| POST | /api/web/tls/{flag} |
设置 HTTPS;flag 为 0 或 1。 |
修改安全路径、Web 端口或 HTTPS 可能使当前请求在服务重启时断开。调用端应根据新地址重新连接,而不是把断开直接判断为保存失败。
读取响应:GET /api/route 直接返回路径字符串,GET /api/web/tls 返回数值状态(0 关闭、非 0 开启)。三个写接口成功时通常返回成功标量或 HTTP 200;由于它们可能切换地址或重启 Web 服务,也可能在修改已生效后断开。
挖矿端口证书
| 方法 | 路径 | 用途 |
|---|---|---|
| GET | /api/cert |
获取全局挖矿端口证书状态。 |
| POST | /api/cert/upload |
上传 PEM 证书和私钥。 |
| GET | /api/cert/reset |
恢复内置证书。 |
上传请求:
{
"pem": "<证书文本先执行 URI 编码,再执行 Base64>",
"key": "<私钥文本先执行 URI 编码,再执行 Base64>"
}
私钥属于敏感数据,不要记录请求体。恢复证书接口虽然会修改状态,但当前前端使用 GET 调用。
GET /api/cert 直接返回数值状态:当前前端把 0 视为未检测到自定义证书、非 0 视为已存在。上传和恢复成功时返回成功标量或 HTTP 200,随后重新查询证书状态。
IP 黑名单
| 方法 | 路径 | 用途 |
|---|---|---|
| GET | /api/ip/blacklist |
获取 IP 黑名单。 |
| POST | /api/ip/blacklist/add |
添加一个或多个 IP。 |
| POST | /api/ip/blacklist/delete |
删除一个或多个 IP。 |
| GET | /api/ip/coming |
获取所有端口 IP 访问记录。 |
| GET | /api/ipblacklist/all/log |
获取 IP 拦截记录。 |
添加和删除请求:
{
"ips": ["192.0.2.10"]
}
返回结构:
/api/ip/blacklist返回string[]。/api/ip/coming返回数组元组;当前实例为[ip, port, time],旧版本也可能返回[ip, time]或{ ip, port, time }。/api/ipblacklist/all/log返回{ t, f, d }[]:t为时间戳,f为竖线分隔事件文本,d为状态/方向值。前端从f的第 3、4 段读取端口和 IP。- 添加和删除成功时返回成功标量或 HTTP 200;写入后重新 GET 黑名单。
钱包黑名单和白名单
| 方法 | 路径 | 用途 |
|---|---|---|
| GET | /api/wallet/blacklist |
获取钱包黑名单。 |
| POST | /api/wallet/blacklist/add |
添加钱包黑名单。 |
| POST | /api/wallet/blacklist/delete |
删除钱包黑名单。 |
| GET | /api/wallet/whitelist |
获取钱包白名单。 |
| POST | /api/wallet/whitelist/add |
添加钱包白名单。 |
| POST | /api/wallet/whitelist/delete |
删除钱包白名单。 |
| GET | /api/bwlist/log |
获取钱包黑/白名单命中日志。 |
钱包添加和删除请求同样使用历史字段名:
{
"ips": ["<钱包地址或子账号>"]
}
返回结构:
- 黑名单和白名单查询均返回
string[]。 /api/bwlist/log返回{ t, f, d }[];f是钱包地址/子账号,d=0在当前前端表示黑名单命中,其他值表示白名单方向。- 添加和删除成功时返回成功标量或 HTTP 200。
程序和操作日志
| 方法 | 路径 | 用途 |
|---|---|---|
| GET | /api/request/log |
获取后台操作日志。 |
| GET | /api/running/log |
获取程序运行日志。 |
| GET | /api/error/log |
获取程序错误日志。 |
| GET | /api/d/tl |
获取矿工连接故障记录。 |
日志响应可能包含钱包、IP、矿池地址和内部错误信息。对外系统展示前应脱敏,并限制日志 API 的访问权限。
程序日志返回字段
| 接口 | 成功响应 |
|---|---|
/api/request/log |
string[],每行通常为 [时间] 操作内容。 |
/api/running/log |
string[] 或换行分隔字符串;每行是运行日志。 |
/api/error/log |
string[] 或换行分隔字符串;每行是错误日志。 |
/api/d/tl |
{ port, coin, wi, ct }[]。 |
连接故障记录中,port 是监听端口,coin 是币种代码,wi 是钱包/矿工相关标识,ct 是累计次数。部分运行状态下该接口可能返回错误而不是空数组,调用方应显示“暂不可用”。
