更新数据库¶

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

POST https://moi.matrixorigin.cn/newmoi/catalog/database/update

调用前准备¶

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

下方示例使用：

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

不要传入 name；该字段会导致请求失败。

请求体¶

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

请求示例¶

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

成功响应¶

成功时返回 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
}

常见 HTTP 错误¶

HTTP 状态码	错误代码	常见原因	建议操作
`400`	`ErrParamInvalid`	请求体或数据库 ID 无效。	使用正整数 ID。
`400`	`ErrDatabaseRenameUnsupported`	请求体包含 `name`。	移除 `name`，只更新说明。
`403`	`ErrForbidden`	当前身份没有更新权限。	请求授予 `database.update` 权限。
`409`	`ErrReadonlySystemDatabase`、`ErrReadonlyReservedDatabase`	目标为只读系统或保留数据库。	不要更新该数据库。
`500`	`ErrServer`	服务端未能更新数据库。	稍后重试。

后续操作¶

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

最后更新于 2026 年 8 月 22 日