# 更新 Catalog

更新 Catalog 的名称和说明。

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

## 调用前准备

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

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递。
- `$CATALOG_ID`：要更新的 Catalog ID。

## 请求体

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `id` | integer | 是 | Catalog ID。 |
| `name` | string | 是 | 新名称，必须是有效标识符。 |
| `description` | string | 否 | 更新后的说明。 |

## 请求示例

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

## 成功响应

成功时返回 `200`，`data` 为 `null`。随后读取详情确认变更。

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

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data` | null | 更新成功时固定为 `null`。 |

## 错误响应

```json
{
  "code": "ErrReadonlySystemCatalog",
  "msg": "系统 Catalog 为只读",
  "data": null
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - 请求体无效、ID 无效或名称不是有效标识符。
  - 核对 `id` 和 `name`。
* - `403`
  - `ErrForbidden`
  - 当前身份没有更新权限。
  - 请求授予 `catalog.update` 权限。
* - `409`
  - `ErrAlreadyExists`
  - 新名称已被其他 Catalog 使用。
  - 更换名称后重试。
* - `409`
  - `ErrReadonlySystemCatalog`
  - 目标为只读系统 Catalog。
  - 不要修改该 Catalog。
* - `500`
  - `ErrServer`
  - 服务端未能更新 Catalog。
  - 稍后重试。
```

## 后续操作

[查询 Catalog 详情](get-catalog.md)确认变更。