查看卷详情¶

按 ID 查询根卷的详情。

POST https://api.moi.matrixorigin.cn/v5/catalog/volume/info

调用前准备¶

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

请求体¶

请求示例

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

参数说明

请求体

字段	类型	必填	说明
`id`	string	是	卷 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。
`name`	string	卷名称。
`display_name`	string	卷显示名称；未提供时可能省略。
`description`	string	卷描述；未提供时可能省略。
`display_description`	string	卷显示描述；未提供时可能省略。

错误响应¶

响应示例

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

字段说明

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

后续操作¶

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

最后更新于 2026 年 9 月 11 日