# 更新文件

此接口保留文件更新的请求形状，但当前实现不会持久化 `name` 的变更。请不要将成功响应视为文件名称已经更新。

```text
POST https://moi.matrixorigin.cn/newmoi/catalog/file/update
```

## 调用前准备

先[查询文件列表](list-files.md)取得目标文件 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和文件 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递。
- `$FILE_ID`：用于定位文件并进行权限校验的文件 ID。

## 请求体

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `file_id` | string | 是 | 用于定位文件并进行权限校验的文件 ID。 |
| `name` | string | 否 | 待更新的文件名；当前实现不会保存该值。 |

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/file/update" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "file_id": "'"$FILE_ID"'",
    "name": "<FILE_NAME>"
  }'
```

## 成功响应

成功时返回 `200`，`data` 为 `null`。当前实现会成功返回，但不会更改文件名称或其他文件属性。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": null
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data` | null | 请求成功返回时固定为 `null`；不表示文件属性已经变更。 |

## 错误响应

```json
{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}
```

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - 请求体不是有效 JSON。
  - 检查 JSON 格式。
* - `403`
  - `ErrForbidden`
  - 当前身份没有所属根卷写入权限。
  - 使用有写入权限的凭据，或联系管理员授权。
* - `500`
  - `ErrServer`
  - 服务端处理请求失败。
  - 记录请求时间和错误信息后重试；持续失败时联系支持人员。
```

## 后续操作

用同一资源标识[查询文件详情](get-file.md)确认更新结果。