创建数据库¶

在指定 Catalog 下创建数据库。

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

调用前准备¶

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

请求体¶

请求示例

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

参数说明

请求体

字段	类型	必填	说明
`catalog_id`	integer	是	父 Catalog ID。
`name`	string	是	数据库名称，必须是有效标识符。
`description`	string	否	数据库说明。

成功响应¶

成功时返回 200。保存 data.id 用于后续操作。

响应示例

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

字段说明

通用字段

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

创建结果

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

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

错误响应¶

响应示例

{
  "code": "ErrAlreadyExists",
  "msg": "数据库名称已存在",
  "data": null
}

字段说明

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

后续操作¶

使用 data.id 查询数据库详情。

最后更新于 2026 年 9 月 28 日