更新卷¶

更新卷的名称和描述。

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

调用前准备¶

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

请求体¶

请求示例

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>"
  }'

参数说明

请求体

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

成功响应¶

成功时返回 200 和已更新卷的 ID。

响应示例

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

字段说明

通用字段

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

更新结果

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

字段	类型	说明
`id`	integer	已更新卷的 ID。

错误响应¶

响应示例

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

字段说明

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

后续操作¶

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

最后更新于 2026 年 9 月 3 日