更新数据库¶

更新数据库说明。该接口不支持重命名。

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

调用前准备¶

先查询数据库列表取得目标数据库 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和数据库 ID。不要传入 name；该字段会导致请求失败。

请求体¶

请求示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/catalog/database/update" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": '"$DATABASE_ID"',
    "description": "<DATABASE_DESCRIPTION>"
  }'

参数说明

请求体

字段	类型	必填	说明
`id`	integer	是	数据库 ID。
`description`	string	否	更新后的说明。

成功响应¶

成功时返回 200 和已更新数据库的 ID。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": 2
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。

更新结果

下面表格展开响应示例中 data 对象；每一行是该对象的一个字段。

字段	类型	说明
`id`	integer 或 null	更新的数据库 ID；服务端未提供时为 `null`。

错误响应¶

响应示例

{
  "code": "ErrDatabaseRenameUnsupported",
  "msg": "不支持重命名数据库",
  "data": null
}

字段说明

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

后续操作¶

用同一资源标识查询数据库详情确认更新结果。

最后更新于 2026 年 9 月 28 日