创建卷¶

在指定数据库下创建根卷。

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

调用前准备¶

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

下方示例使用：

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

请求体¶

参数	类型	是否必填	说明
`database_id`	integer	是	父数据库 ID。
`name`	string	是	卷名称，必须是有效标识符。
`description`	string	否	卷描述。

请求示例¶

curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/volume/create" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "database_id": '"$DATABASE_ID"',
    "name": "<VOLUME_NAME>",
    "description": "<VOLUME_DESCRIPTION>"
  }'

成功响应¶

成功时返回 200 和新卷 ID。该响应表示卷已创建。

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

响应字段如下。

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data.id`	integer	新建卷的 ID。

错误响应¶

{
  "code": "ErrAlreadyExists",
  "msg": "对象已存在",
  "data": null
}

常见 HTTP 错误¶

HTTP 状态码	错误代码	常见原因	建议操作
`400`	`ErrParamInvalid`	`database_id`、`name` 缺失或卷名称无效。	检查目标数据库 ID 和卷名称。
`403`	`ErrForbidden`	当前身份没有在目标数据库创建卷的权限。	使用有写入权限的凭据，或联系管理员授权。
`409`	`ErrReadonlySystemDatabase`、`ErrReadonlyReservedDatabase`	目标数据库不可写。	选择可写数据库。
`409`	`ErrAlreadyExists`	目标数据库中已有同名卷。	使用其他卷名称。
`500`	`ErrServer`	服务无法创建卷。	记录请求时间和错误信息后重试；持续失败时联系支持人员。

后续操作¶

使用 data.id 查询卷详情。

最后更新于 2026 年 8 月 22 日