工作区
| 工具 | 作用 |
|---|---|
ListWorkspaces | 列出当前账号可访问的工作区。 |
GetBitcoinMetrics | 返回 Bitcoin 价格、hashprice、全网算力和难度的当前值。 |
QueryBitcoinMetrics | 按时间序列返回 Bitcoin 挖矿市场的历史指标。 |
矿场
| 工具 | 作用 |
|---|---|
ListFarms | 列出工作区内的矿场。 |
GetFarm | 按 ID 获取单个矿场。 |
ListAgents | 列出矿场内的 Agent。 |
GetAgent | 按 ID 获取单个 Agent。 |
QueryFarmMetrics | 返回矿场的分时段汇总指标。 |
QueryFarmMinerMetrics | 返回矿场当前的矿机分类数量,以及挖矿模式和机型的分布。 |
QueryFarmHashrateComparisonMetrics | 对比矿场在 7 天或 28 天窗口内与上一个窗口的矿池算力。 |
QueryFarmMonitorEventMetrics | 返回矿场监控事件的汇总数量。 |
ListFarmRebootEvents | 列出矿场内检测到的重启事件。 |
ListRacks | 已弃用。列出矿场内的机架及各机架的矿机数量。请改用 ListRackGroups。 |
矿箱
矿箱相关工具目前是 beta 功能。模型说明见矿箱、模板与布局。| 工具 | 作用 |
|---|---|
ListRackGroups | 列出矿场的全部矿箱,包含网段、模板和矿机汇总。 |
ListRackGroupTemplates | 列出矿场可用的系统模板和矿场模板。 |
GetFarmLayout | 获取矿场的排、位置、叠放和通道。 |
修改矿箱、模板和布局
以下工具修改的是矿场配置,不会向矿机下发命令。执行前请核对计划修改的内容。用
UpdateRackGroups 替换网段时,落在新网段内的矿箱会被合并并删除。| 工具 | 作用 |
|---|---|
UpdateRackGroups | 给矿箱命名,设置模板和起始偏移,或替换网段。 |
CreateRackGroupTemplate | 创建矿场模板。 |
UpdateRackGroupTemplate | 修改矿场模板。使用该模板的矿箱随之变化。 |
DeleteRackGroupTemplate | 删除矿场模板。使用该模板的矿箱变为没有模板。 |
UpdateFarmLayout | 整体替换矿场布局。 |
矿机
| 工具 | 作用 |
|---|---|
ListMiners | 列出矿场内的矿机。 |
GetMiner | 按 ID 获取单台矿机。 |
ListMinerTasks | 列出单台矿机的 Task 执行记录。 |
ListMinerRebootTasks | 列出单台矿机的重启 Task 记录。 |
QueryMinerMetrics | 返回单台矿机的分时段性能指标。 |
ListMinerRebootEvents | 列出单台矿机检测到的重启事件。 |
Automation
| 工具 | 作用 |
|---|---|
ListAutomations | 列出矿场内配置的 Automation。 |
ListAutomationTasks | 列出单个 Automation 下发且执行成功的 Task,有关联的重启恢复数据时一并返回。 |
QueryAutomationMetrics | 返回单个 Automation 的分时段执行次数。 |
搜索
| 工具 | 作用 |
|---|---|
SearchMiners | 按条件搜索矿场内的矿机。 |
SearchTaskBatches | 按条件搜索矿场内的 Task Batch。 |
SearchFarmMonitorEvents | 按条件搜索矿场内的监控事件。 |
Task
| 工具 | 作用 |
|---|---|
ListTaskBatches | 列出矿场内的 Task Batch。 |
GetTaskBatch | 按 ID 获取单个 Task Batch。 |
ListTaskBatchTasks | 列出 Task Batch 中的各个 Task。 |
ListTaskBatchRecoveries | 列出 Task Batch 中执行成功的 Task 及其关联的重启恢复数据。 |
创建 Task Batch
本节中的每个工具都会创建 Task Batch,并向矿机或 Agent 下发操作。执行前请确认目标和参数。
CreateRecordDeleteTaskBatch 会删除矿机记录及其机架位置;已删除但仍在线的矿机会在下一次上报后重新出现。| 工具 | 作用 |
|---|---|
CreateRebootTaskBatch | 重启指定矿机。 |
CreateFirmwareUpdateTaskBatch | 更新指定矿机的固件。 |
CreatePoolLockTaskBatch | 锁定或解锁指定矿机的矿池配置。 |
CreateMiningModeUpdateTaskBatch | 更新指定矿机的挖矿模式。 |
CreateLightUpdateTaskBatch | 切换指定矿机的指示灯。 |
CreateLogGetTaskBatch | 收集指定矿机的诊断日志。 |
CreateTagsUpdateTaskBatch | 添加或移除指定矿机的标签。 |
CreateNetworkUpdateTaskBatch | 为指定矿机设置静态 IP 或 DHCP 网络配置。 |
CreateRecordDeleteTaskBatch | 从矿场中删除指定矿机的记录。 |
CreateAgentScanTaskBatch | 在矿场的 Agent 上触发矿机发现扫描。 |
CreateAgentIpDiagnosisTaskBatch | 在矿场的 Agent 上运行 IP 连通性诊断。 |
CreateAgentSelfUpdateTaskBatch | 触发矿场内 Agent 的自更新。 |
CreateAgentPauseTaskBatch | 暂停矿场内所有 Agent 的矿机数据上报。矿场内有 Agent 离线时返回 AGENT_OFFLINE。 |
CreateAgentResumeTaskBatch | 恢复矿场内所有 Agent 的矿机数据上报。矿场内有 Agent 离线时返回 AGENT_OFFLINE。 |