更新卷¶

更新卷的名称和描述。

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

调用前准备¶

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

下方示例使用：

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

请求体¶

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

请求示例¶

curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/volume/update" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": '"$VOLUME_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`	`id`、`name` 缺失，或新名称无效。	检查卷 ID 和名称。
`403`	`ErrForbidden`	当前身份没有该卷的写入权限。	使用有写入权限的凭据，或联系管理员授权。
`409`	`ErrAlreadyExists`	同一数据库下已有同名卷。	使用其他名称。
`500`	`ErrServer`	服务无法更新卷。	记录请求时间和错误信息后重试；持续失败时联系支持人员。

后续操作¶

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

最后更新于 2026 年 8 月 22 日