|
|
@@ -83,9 +83,11 @@ sudo docker exec mass-base cat /var/lib/mass-base/initial_admin_password
|
|
|
|
|
|
在浏览器中打开 `http://<服务器IP>`，使用用户名 `admin` 和上一步获取的密码登录。
|
|
|
|
|
|
+> **注意：** 本项目为纯后端服务，前端请使用独立部署的 UI 镜像。
|
|
|
+
|
|
|
### 4. 部署模型
|
|
|
|
|
|
-1. 在 MASS-Base UI 中进入 **Catalog** 页面。
|
|
|
+1. 在前端 UI 中进入 **Catalog** 页面。
|
|
|
2. 选择可用模型，通过兼容性检查后点击 **Save** 部署。
|
|
|
3. 部署状态变为 **Running** 后即可通过 UI Playground 或 API 调用。
|
|
|
|
|
|
@@ -109,6 +111,88 @@ curl http://your_mass_base_server_url/v1/chat/completions \
|
|
|
}'
|
|
|
```
|
|
|
|
|
|
+## API 接口文档
|
|
|
+
|
|
|
+本项目为纯后端服务，提供 RESTful API 供前端调用。所有 API 基础路径为 `http://<服务器IP>`。
|
|
|
+
|
|
|
+### 认证方式
|
|
|
+
|
|
|
+| 方式 | 说明 |
|
|
|
+|------|------|
|
|
|
+| **Cookie 认证** | 登录后通过 Cookie `gpustack_session` 访问 |
|
|
|
+| **Bearer Token** | 在 Header 中添加 `Authorization: Bearer <token>` |
|
|
|
+| **API Key** | 在 Header 中添加 `X-API-Key: <api_key>` |
|
|
|
+| **Basic Auth** | 用户名密码 Basic 认证 |
|
|
|
+
|
|
|
+### 核心管理 API（`/v2` 前缀）
|
|
|
+
|
|
|
+| 资源 | 路径 | 说明 |
|
|
|
+|------|------|------|
|
|
|
+| 用户 | `/v2/users` | 用户管理（CRUD） |
|
|
|
+| 我的信息 | `/v2/users/me` | 当前用户信息 |
|
|
|
+| API 密钥 | `/v2/api-keys` | API Key 管理 |
|
|
|
+| 用量统计 | `/v2/usage` | API 调用用量统计 |
|
|
|
+| 集群 | `/v2/clusters` | 集群管理 |
|
|
|
+| Worker | `/v2/workers` | Worker 节点管理 |
|
|
|
+| Worker 池 | `/v2/worker-pools` | Worker 池管理 |
|
|
|
+| GPU 设备 | `/v2/gpu-devices` | GPU 设备信息 |
|
|
|
+| 云凭证 | `/v2/cloud-credentials` | 云厂商凭证管理 |
|
|
|
+| 模型 | `/v2/models` | 模型管理 |
|
|
|
+| 模型实例 | `/v2/model-instances` | 模型实例管理 |
|
|
|
+| 模型文件 | `/v2/model-files` | 模型文件管理 |
|
|
|
+| 模型集 | `/v2/model-sets` | 模型集合 |
|
|
|
+| Draft 模型 | `/v2/draft-models` | 草稿模型 |
|
|
|
+| 推理后端 | `/v2/inference-backends` | 推理后端配置 |
|
|
|
+| 模型提供商 | `/v2/model-providers` | 模型提供商 |
|
|
|
+| 模型路由 | `/v2/model-routes` | 模型路由配置 |
|
|
|
+| 模型路由目标 | `/v2/model-route-targets` | 模型路由目标 |
|
|
|
+| 模型路由主体 | `/v2/model-routes` | 模型路由主体（Principal） |
|
|
|
+| 模型评估 | `/v2/model-evaluations` | 模型评估 |
|
|
|
+| 基准测试 | `/v2/benchmarks` | 基准测试 |
|
|
|
+| 测试配置 | `/v2/benchmark-profiles` | 基准测试配置 |
|
|
|
+| 组织 | `/v2/organizations` | 组织管理 |
|
|
|
+| 组织成员 | `/v2/organizations/members` | 组织成员管理 |
|
|
|
+| 用户组 | `/v2/user-groups` | 用户组管理 |
|
|
|
+| 我的组织 | `/v2/users/me/orgs` | 当前用户所属组织 |
|
|
|
+| 仪表板 | `/v2/dashboard` | 仪表板数据（仅管理员） |
|
|
|
+| 集群访问 | `/v2/cluster-access` | 集群访问控制 |
|
|
|
+
|
|
|
+### 推理 API（OpenAI 兼容）
|
|
|
+
|
|
|
+| 路径 | 说明 |
|
|
|
+|------|------|
|
|
|
+| `/v1/chat/completions` | 对话补全 |
|
|
|
+| `/v1/completions` | 文本补全 |
|
|
|
+| `/v1/embeddings` | Embedding 向量 |
|
|
|
+| `/v1/models` | 可用模型列表 |
|
|
|
+| `/v1/rerank` | 重排序 |
|
|
|
+
|
|
|
+> `/v1-openai/*` 为旧版兼容路径，推荐使用 `/v1/*`。
|
|
|
+
|
|
|
+### 健康检查
|
|
|
+
|
|
|
+| 路径 | 说明 |
|
|
|
+|------|------|
|
|
|
+| `/healthz` | 健康检查 |
|
|
|
+| `/readyz` | 就绪检查 |
|
|
|
+
|
|
|
+### 认证相关
|
|
|
+
|
|
|
+| 路径 | 说明 |
|
|
|
+|------|------|
|
|
|
+| `/auth/login` | 用户登录 |
|
|
|
+| `/auth/token` | Token 相关 |
|
|
|
+
|
|
|
+### WebSocket
|
|
|
+
|
|
|
+| 路径 | 说明 |
|
|
|
+|------|------|
|
|
|
+| `/ws/*` | WebSocket 代理 |
|
|
|
+
|
|
|
+### OpenAPI 文档
|
|
|
+
|
|
|
+启动后可访问 `http://<服务器IP>/docs` 查看完整的 Swagger/OpenAPI 文档。
|
|
|
+
|
|
|
## 完整部署指南
|
|
|
|
|
|
如需更详细的部署说明（含 Docker Compose 完整监控栈、Worker 节点独立部署、Kubernetes Helm 部署等），请参见：
|
