查询卷详情¶

按 ID 查询根卷的详情。

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

调用前准备¶

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

下方示例使用：

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

请求体¶

参数	类型	是否必填	说明
`id`	string	是	卷 ID。

请求示例¶

curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/volume/info" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "'"$VOLUME_ID"'"
  }'

成功响应¶

成功时返回 200 和卷信息。调用者必须有该卷的读取权限。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "volume": {
      "id": 789,
      "name": "sales_files",
      "display_name": "销售文件",
      "description": "销售文件",
      "display_description": "销售文件"
    }
  }
}

响应字段如下。

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data.volume.id`	integer	卷 ID。
`data.volume.name`	string	卷名称。
`data.volume.display_name`	string	卷显示名称；未提供时可能省略。
`data.volume.description`	string	卷描述；未提供时可能省略。
`data.volume.display_description`	string	卷显示描述；未提供时可能省略。

错误响应¶

{
  "code": "ErrParamInvalid",
  "msg": "id 无效",
  "data": null
}

常见 HTTP 错误¶

HTTP 状态码	错误代码	常见原因	建议操作
`400`	`ErrParamInvalid`	`id` 缺失或格式无效。	传入有效的卷 ID。
`403`	`ErrForbidden`	当前身份没有该卷的读取权限。	使用有读取权限的凭据，或联系管理员授权。
`500`	`ErrServer`	服务无法读取卷信息。	记录请求时间和错误信息后重试；持续失败时联系支持人员。

后续操作¶

需要修改时更新卷。返回列表时查询文件产物。

最后更新于 2026 年 8 月 22 日