文档
代理端口与抽水钱包 API
RustMinerSystem 代理端口创建、编辑、启停、导入、矿池连通性和抽水钱包接口。
代理端口与抽水钱包 API
端口和钱包接口会直接改变挖矿代理行为。建议对创建、修改和删除操作启用二步验证,并在批量调用前备份配置。
端口生命周期
| 方法 | 路径 | 用途 |
|---|---|---|
| GET | /api/ports |
获取全部代理端口及实时统计。 |
| GET | /api/port/{id} |
获取端口、设置和抽水钱包完整配置。 |
| POST | /api/port/new |
创建代理端口。 |
| POST | /api/port/{id} |
编辑指定端口。 |
| POST | /api/port/{id}/start |
启动端口。 |
| POST | /api/port/{id}/stop |
停止端口。 |
| DELETE | /api/port/{id} |
删除端口。 |
| POST | /api/ports/import |
批量导入端口。 |
| POST | /api/ping |
测试目标矿池连通性。 |
{id} 是端口记录 ID,不一定等于监听端口号。图表接口中的端口标识可能使用实际监听端口,调用时不要混用。
创建或编辑端口
创建和编辑使用相同主体结构。简化示例:
{
"port": 3333,
"name": "BTC Proxy",
"currency": "BTC",
"category": "sha256",
"protocol": 0,
"limit_connections": 60000,
"pool_address": "stratum.example.com:3333",
"pool_address2": "backup.example.com:3333",
"connect_mode": 0,
"connect_mode2": 0,
"mode": 0,
"nc": 0,
"pattern_addr": "",
"replace_addr": "",
"wallets": [],
"setting": {}
}
常用字段:
| 字段 | 说明 |
|---|---|
port |
本地监听端口,范围 1–65534。 |
currency / category |
币种代码和算法类别。 |
protocol |
本地监听协议枚举。 |
pool_address / pool_address2 |
主、备用矿池地址。 |
connect_mode / connect_mode2 |
上游 TCP/TLS 连接模式。 |
mode |
透明、转发或统一钱包等工作模式。 |
wallets |
随端口一起提交的抽水钱包数组。 |
setting |
压缩、强制成功、替换矿工名等高级设置。 |
外部调用不执行后台二步验证流程,只需发送自定义 API 鉴权请求头;各凭据可修改的接口范围将在权限模型完成后补充。
批量导入
POST /api/ports/import
{
"ports": [
{}
]
}
响应通常是逐端口的错误列表。调用方应展示部分失败,不能因为 HTTP 200 就认为全部导入成功。
测试矿池地址
POST /api/ping
{
"address": "stratum.example.com:3333",
"conn_type": 0
}
conn_type 在新版前端中使用 0 表示普通连接,1 表示 TLS/SSL 类连接。
抽水钱包热更新
| 方法 | 路径 | 用途 |
|---|---|---|
| POST | /api/wallet/new |
添加抽水钱包。 |
| POST | /api/wallet/{id} |
更新抽水钱包。 |
| DELETE | /api/wallet/{id} |
删除抽水钱包。 |
添加/更新请求示例:
{
"server_id": 1,
"addr": "fee-wallet",
"device": "fee-worker",
"pool_address": "pool.example.com:3333",
"pool_protocol": 0,
"ratio": 0.01
}
更新时还会包含钱包 id。ratio 使用 0–1 小数,例如 0.01 表示 1%。pool_protocol 在当前前端中使用 0 表示 TCP,1 表示 TLS/SSL。
