跳转到主要内容
Task 是作用于一台矿机或一个 Agent 的单次操作,或一项矿机记录变更。Task 不能逐个创建:每个创建接口生成一个 Task Batch,Nonce 再为每个目标生成对应的 Task。本页说明各创建接口、参数、响应,以及用来跟踪执行情况的状态。

Task 与 Task Batch

两个术语对应同一次请求的两个层级。

操作影响与权限

不同 Task 的影响范围和权限要求不同。 创建 Task Batch 时,账号角色须具备对应的操作权限,目标矿场也须在其授权范围内。各角色可执行的操作见各角色的权限。

创建 Task Batch

每种操作在矿场的 /task-batches 下有各自的路径。路径决定操作类型,请求体不包含 task_name。
创建接口目前是 Beta,请求或响应可能发生不兼容变更。见版本与稳定性。
以下请求打开两台矿机的指示灯:
请求体最多包含两个字段: 从 v1 迁移时,参见接口和字段对照。

矿机操作

这类操作在 miner_ids 列出的矿机上执行。task_name 一列是 Task Batch 响应和 ListTaskBatches 的 task_name 筛选条件中,该操作对应的值。 Task 名称 miner.pool.update 用于更新矿池配置,没有 API 接口可以创建它。

矿机记录操作

这类操作修改 miner_ids 所列矿机的清单记录,不会向设备下发任何内容。

Agent 操作

这类操作在矿场的 Agent 上执行,请求中没有 miner_ids。

操作参数

下面各表列出每种操作的 params 接受哪些字段。完整的请求和响应结构以 API Reference 中对应的接口为准。

CreateRebootTaskBatch

params 可省略。

CreateLogGetTaskBatch

该操作没有 params,只需传 miner_ids。

CreateLightUpdateTaskBatch

CreateMiningModeUpdateTaskBatch

CreatePoolLockTaskBatch

矿池锁定通过 auth package 固定矿池配置,锁定期间可防止未授权的矿池修改。

CreateFirmwareUpdateTaskBatch

CreateTagsUpdateTaskBatch

标签只是元数据,该操作不影响挖矿。params 必填,可以只传 add 或 remove,也可以都传。

CreateRecordDeleteTaskBatch

矿机物理下架后使用该操作。params 可省略。
删除矿机记录会同时清除其机架位置。已删除但仍在线的矿机,下一次上报成功后会重新出现,且不带机架位置。

CreateAgentScanTaskBatch

params 必填,但可以是空对象。

CreateAgentIpDiagnosisTaskBatch

params 必填,但可以是空对象。

CreateAgentSelfUpdateTaskBatch

params 必填,但可以是空对象。

CreateAgentPauseTaskBatch 和 CreateAgentResumeTaskBatch

两个操作的请求体都是空 JSON 对象。 暂停期间,Agent 仍会扫描、采集矿机数据并发送心跳,恢复后立即上报最新数据。矿场内只要有 Agent 处于暂停状态,该矿场就只能创建暂停、恢复、自更新和扫描这四种 Task Batch,其他创建请求会返回 VALIDATION_ERROR。
暂停和恢复要求矿场内所有 Agent 均在线。若有 Agent 离线,API 返回 AGENT_OFFLINE,且不创建 Task Batch。

读取响应

创建接口返回已创建的 Task Batch、汇总数据,以及被跳过的矿机:
请保存 data.batches 中每个 Task Batch 的 id,跟踪 Task Batch 时要用到。created_by 对象的说明见操作者。

汇总

data.summary 统计的是矿机数量,不是 Task 数量。

被跳过的矿机

data.skipped 按原因对被跳过的矿机分组,每一项包含以下字段: 矿机被跳过的原因有以下几种:

跟踪 Task Batch

创建 Task Batch 后,用 GetTaskBatch 查询汇总状态和各状态的 Task 数量,用 ListTaskBatchTasks 查询每个 Task 的状态、时间戳、结果和错误。ListTaskBatchTasks 支持按 status 筛选;日志收集的每个 Task 还会带有签名的 log_download_url。

Task 状态

每个 Task 会经过以下状态: Task 最终停在四种状态之一:
Task 依次经过 created、queuing、pending,最终以 succeed、failed、timed_out 或 cancelled 结束。Task 生命周期

Task Batch 状态

Task Batch 的 status 由其中所有 Task 的状态汇总得出:

挖矿模式

mining_mode 接受下表四种通用模式之一,或长度不超过 36 个字符的机型专属预设名称,例如 5600W。 不是所有设备都支持全部模式,支持哪些模式取决于厂商: 给矿机设置厂商不支持的模式时,请求会返回验证错误。

相关文档