# 上传到个人私有 Catalog 卷

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

上传文件并自动关联到当前用户的私有卷，返回文件 ID 及卷位置。

```text
POST https://api.moi.matrixorigin.cn/v5/workspaces/{id}/catalog-files/uploads
```

## 调用前准备

`BASE_URL` 使用产品 API 前缀 `https://api.moi.matrixorigin.cn/v5`；专有部署填写对应的产品 API 地址。

准备目标工作区个人访问令牌；WORKSPACE_ID须与路径工作区一致，FILE_ID来自实际文件结果。BASE_URL包含同环境产品前缀，示例文件/ID仅为占位值。

## 请求参数

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 输入示例

```bash
curl --fail-with-body -sS -X POST "$BASE_URL/workspaces/$WORKSPACE_ID/catalog-files/uploads" \
  -H "X-API-Key: $MOI_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -F "file=@$UPLOAD_FILE;type=text/plain"
```

:::::
:::::{tab-item} 参数说明

| 字段 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `file` | file | 是 | multipart 文件。 |

成功为HTTP201。已自动建立卷关联，不必重复调用创建文件关联；文件记录、存储和发布关联可能分阶段失败。

:::::
::::::
:::::::

## 成功响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "file_id": "file-example",
    "original_name": "sample.txt",
    "size": 7,
    "md5": "5177a58dc65c8a14dc90c69db3bf3dd2",
    "catalog_file": {
      "workspace_id": "workspace-example",
      "volume_id": 30,
      "file_id": "file-example",
      "path": "sample.txt",
      "name": "sample.txt",
      "size": 7,
      "md5": "5177a58dc65c8a14dc90c69db3bf3dd2"
    }
  }
}
```

:::::
:::::{tab-item} 字段说明

成功使用字符串code=OK、msg=OK。data含file_id、original_name、size、md5、catalog_file。catalog_file含workspace_id、volume_id、file_id、path、name、size、md5，见[上传位置](objects.md#private-location)。

:::::
::::::
:::::::

## 错误响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": "ErrParamInvalid",
  "msg": "示例本地化错误"
}
```

:::::
:::::{tab-item} 字段说明

错误使用字符串code/msg。参数、权限、存储和依赖错误按实际响应处理。

:::::
::::::
:::::::
