RustMinerSystem

文档

仪表盘、版本与系统配置 API

RustMinerSystem 币种、系统资源、版本、RMS、通知、快捷矿池和 KENC 配置接口。

仪表盘、版本与系统配置 API

本章覆盖后台仪表盘、程序版本和常用系统配置。外部 API 调用无需登录，每次请求直接携带自定义 API 鉴权请求头。

币种和系统信息

方法 路径 用途/主要参数
GET /api/currency/config 获取币种、算法、图标和公开状态配置。
GET /api/sys/base/info 获取操作系统、CPU、内存、磁盘等基础信息。
GET /api/sys/stat 获取 CPU、内存和网络流量历史。
GET /api/device/stats 获取全部设备数量历史。
GET /api/currency/online/stat/{coin} 获取指定币种在线设备历史。
GET /api/stat/currency/{currency} 获取指定币种算力历史。
POST /api/config/refresh 请求更新算法引擎。不要高频调用。

路径中的 {coin} 和 {currency} 使用后端币种代码，例如 BTC、KAS 或节点币种代码。

版本和运行状态

方法 路径 用途
GET /api/local/version 获取当前运行版本。
GET /api/version 获取远程版本、更新和 APP 中心配置。
GET /api/releases 获取版本更新日志。
GET /api/sys/starttime 获取程序启动时间戳。
GET /api/mb/port 获取移动端访问端口和状态。
GET /api/u/i 获取当前实例 UUID。
POST /api/failed/reset 重置程序崩溃/启动失败标记。

版本响应在不同后端版本中可能是字符串或包含 version 的对象，调用端应同时兼容。

掉线推送设置

GET /api/warning/setting
POST /api/warning/setting

新版前端使用的配置字段包括：

{
  "is_off": 0,
  "wr": 0,
  "key": "<Server酱 Key>",
  "smtp_email": "[email protected]",
  "smtp_secret": "<SMTP 密码或授权码>",
  "smtp_endpoint": "smtp.example.com",
  "smtp_port": 465,
  "smtp_use_tls": 1
}

后端版本还可能返回算力下降阈值等字段。保存时建议先读取现有对象，只修改需要的字段，避免覆盖新增配置。

RMS 客户端配置

GET /api/rms/config
POST /api/rms/config

保存请求示例：

{
  "ports": {},
  "code": "",
  "mode": 0,
  "title": "RMS",
  "pool_mode": 0,
  "notice": "",
  "info": "",
  "peers": {},
  "host": "miner.example.com",
  "protocol": 1
}

首次获取返回未注册状态时，新版前端会用 mode: 0、pool_mode: 0 和默认标题自动注册。保存时前端还会自动写入当前页面的 host，并以 protocol=1 表示 HTTPS、0 表示 HTTP。ports、peers 均为以端口为键的对象，内部字段应以当前后台读取到的结构为准。

快捷矿池和钱包配置

方法 路径 用途
GET /api/local/pool/endpoint 获取快捷矿池、钱包和自定义配置。
POST /api/local/pool/endpoint 保存完整快捷配置对象。
GET /api/pool/info/{id} 获取预置矿池列表；新版前端使用 id=1。

POST /api/local/pool/endpoint 会提交完整配置对象。自动化修改前应先 GET、合并目标字段，再 POST，避免删除用户已有的 customPool 或 customWallet。

KENC 密钥

方法 路径 用途
GET /api/kc/key 获取 KENC 自定义密钥。
POST /api/kc/key 保存 KENC 自定义密钥。
POST /api/kc/reset 恢复默认 KENC 密钥。

保存请求：

{
  "k": "<自定义密钥>"
}

修改密钥可能影响已有客户端连接，操作前应确认客户端和服务端配置一致。