创建数据库

在指定 Catalog 下创建数据库。

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

调用前准备

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

下方示例使用:

  • $AI_STUDIO_API_KEY:实际个人访问令牌,通过 X-API-Key Header 传递。

  • $WORKSPACE_ID:目标工作区 ID,通过 X-Workspace-ID Header 传递。

  • $CATALOG_ID:要在其下创建数据库的父 Catalog ID。

请求体

参数

类型

是否必填

说明

catalog_id

integer

父 Catalog ID。

name

string

数据库名称,必须是有效标识符。

description

string

数据库说明。

请求示例

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

成功响应

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

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

请求字段缺失,或名称不是有效标识符。

检查 catalog_idname

403

ErrForbidden

当前身份没有在父 Catalog 创建数据库的权限。

请求授予 database.create 权限。

409

ErrAlreadyExists

父 Catalog 中已有同名数据库。

更换名称。

409

ErrReadonlySystemCatalogErrReadonlySystemDatabase

父对象为只读系统对象。

选择可写 Catalog。

500

ErrServer

服务端未能创建数据库。

稍后重试。

后续操作

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

最后更新于