RustMinerSystem

文档

观察者只读 API

RustMinerSystem 观察者模式的启停、TOKEN、币种、矿工、图表和日志只读查询接口。

观察者只读 API

观察者模式允许不登录管理后台的用户按钱包或子账号查询矿工数据。它使用独立的观察者 TOKEN，只提供前端已实现的只读查询。

管理观察者模式

方法 路径 用途
GET /api/ob 获取观察者状态和 TOKEN。
POST /api/ob/{flag} 开启或关闭观察者模式；flag 为 1 或 0。

这两个管理接口由外部程序调用时使用通用自定义 API 请求头，无需登录。GET /api/ob 的前端读取字段为：

{
  "ob": 1,
  "token": "<观察者 TOKEN>"
}

观察者鉴权

公开页面不发送后台 Authorization，而是发送：

X-OB-TOKEN: <观察者 TOKEN>

新版前端可以从访问链接的 token 或 ob 查询参数读取 TOKEN，并保存到浏览器本地存储。为降低泄漏风险，第三方客户端应优先通过安全配置传入请求头，不要把 TOKEN 长期放在 URL 中。

可调用接口

方法 路径 用途
GET /api/currency/config 获取可查询币种。
GET /api/d/{coin}/g/workers 按币种、钱包或子账号查询矿工。
GET /api/stat/worker/{id} 获取矿工算力图表。
GET /api/group/{gid}/log 获取矿工连接日志。
GET /api/worker/{id}/error/log 获取矿工失败数据流。

查询矿工

GET /api/d/BTC/g/workers?device=0&size=50&page=1&col=s_thh&desc=1&wallet=wallet-name
X-OB-TOKEN: <观察者 TOKEN>
参数 说明
coin URL 中的币种代码，需要 URL 编码。
wallet 钱包地址或子账号；多个值使用逗号分隔。
device 状态筛选。
size / page 分页。
col / desc 排序字段和方向。

响应结构与后台端口矿工列表相同，包含 workers、total 和 stat。

安全边界

  • 观察者 TOKEN 泄漏后，应关闭并重新开启观察者模式以更新凭据。
  • 只向可信用户提供观察者链接。
  • 反向代理应允许 X-OB-TOKEN，但不要把该请求头写入访问日志。
  • 不应把观察者 TOKEN 当作后台 TOKEN，也不能用于修改端口或钱包。