HeteroFlow 是本站的异构算力与大模型调度产品。API 参考。API 参考 HeteroFlow V2 提供完整的 RESTful API，支持所有集群管理和推理服务操作。 基础信息 - REST API ： - OpenAI API ： - 认证方式 ：JWT Token（Header: ） - Agent 认证 ：API Key（Hea…
API 参考
HeteroFlow V2 提供完整的 RESTful API，支持所有集群管理和推理服务操作。
基础信息
- REST API：
http://<server-ip>:3333/api/v1 - OpenAI API：
http://<server-ip>:3333/v1 - 认证方式：JWT Token（Header:
Authorization: Bearer <token>） - Agent 认证：API Key（Header:
X-API-Key: <key>）
认证
用户登录
POST /api/v1/auth/login
{"username": "admin", "password": "admin123"}
返回 JWT Token，有效期 72 小时。
API 模块
认证接口
| 方法 | 路径 | 说明 |
|---|
| POST | /api/v1/auth/login | 用户登录 |
节点管理
| 方法 | 路径 | 说明 |
|---|
| GET | /api/v1/nodes | 节点列表 |
| GET | /api/v1/nodes/{id} | 节点详情 |
| POST | /api/v1/nodes | 创建/注册节点 |
| DELETE | /api/v1/nodes/{id} | 删除节点 |
| POST | /api/v1/nodes/{id}/heartbeat | 节点心跳 |
| GET | /api/v1/nodes/metrics/{id} | 监控指标 |
任务管理
| 方法 | 路径 | 说明 |
|---|
| GET | /api/v1/tasks | 任务列表 |
| GET | /api/v1/tasks/{id} | 任务详情 |
| POST | /api/v1/tasks | 创建任务 |
| POST | /api/v1/tasks/{id}?action=cancel | 取消任务 |
| POST | /api/v1/tasks/{id}?action=retry | 重试任务 |
| POST | /api/v1/tasks/{id}/sleep | 休眠任务 |
| POST | /api/v1/tasks/{id}/wake | 唤醒任务 |
| POST | /api/v1/tasks/{id}/stop | 停止任务 |
推理服务
| 方法 | 路径 | 说明 |
|---|
| GET | /api/v1/task-groups | 服务列表 |
| POST | /api/v1/task-groups | 创建服务 |
| GET | /api/v1/task-groups/{id} | 服务详情 |
| DELETE | /api/v1/task-groups/{id} | 删除服务 |
| PUT | /api/v1/task-groups/{id}/scale | 手动扩缩 |
| PUT | /api/v1/task-groups/{id}/scale-policy | 自动伸缩策略 |
| PUT | /api/v1/task-groups/{id}/update | 滚动更新 |
| PUT | /api/v1/task-groups/{id}/schedule-window | 调度窗口 |
模型管理
| 方法 | 路径 | 说明 |
|---|
| GET | /api/v1/models | 模型列表 |
| POST | /api/v1/models | 创建模型 |
| GET | /api/v1/models/{id} | 模型详情 |
| DELETE | /api/v1/models/{id} | 删除模型 |
| GET | /api/v1/models/discovered | 扫描发现的模型 |
| POST | /api/v1/models/discovered/add | 添加发现的模型 |
网关
| 方法 | 路径 | 说明 |
|---|
| POST | /v1/chat/completions | OpenAI 兼容推理 |
| GET | /v1/models | 可用模型列表 |
| GET | /api/v1/gateway/endpoints | 端点列表 |
| POST | /api/v1/gateway/endpoints | 创建端点 |
| DELETE | /api/v1/gateway/endpoints/{id} | 删除端点 |
模型路由
| 方法 | 路径 | 说明 |
|---|
| GET | /api/v1/model-routes | 路由列表 |
| POST | /api/v1/model-routes | 创建路由 |
| PUT | /api/v1/model-routes/{id} | 更新路由 |
| DELETE | /api/v1/model-routes/{id} | 删除路由 |
调度器
| 方法 | 路径 | 说明 |
|---|
| GET | /api/v1/scheduler/config | 获取配置 |
| PUT | /api/v1/scheduler/config | 更新配置 |
用户管理
| 方法 | 路径 | 说明 |
|---|
| GET | /api/v1/users | 用户列表 |
| POST | /api/v1/users | 创建用户 |
| PUT | /api/v1/users/{id} | 更新用户 |
| DELETE | /api/v1/users/{id} | 删除用户 |