更新 Catalog¶

更新 Catalog 的名称和说明。

POST https://api.moi.matrixorigin.cn/v5/catalog/update

调用前准备¶

先查询 Catalog 列表取得目标 Catalog ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和 Catalog ID。

请求体¶

请求示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/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>"
  }'

参数说明

请求体

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

成功响应¶

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

响应示例

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

字段说明

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

错误响应¶

响应示例

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

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	错误信息。
`data`	null	错误响应中的附加数据；本示例为 `null`。

后续操作¶

查询 Catalog 详情确认变更。

最后更新于 2026 年 9 月 11 日