# 查询卷完整路径

获取卷在 Catalog 层级中的完整路径。

```text
POST https://moi.matrixorigin.cn/newmoi/catalog/volume/full_path
```

## 调用前准备

先[查询数据库中的对象](list-database-objects.md)取得目标卷 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和卷 ID。

下方示例使用：

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

## 请求体

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `id` | integer | 是 | 卷 ID。 |

## 请求示例

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

## 成功响应

成功时返回 `200` 和该卷的层级路径。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "path": "sales/catalog_a/db_a/sales_files"
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.path` | string | 卷在 Catalog 层级中的完整路径。 |

## 错误响应

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

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

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

## 后续操作

需要修改时[更新数据库](update-database.md)。返回列表时[查询文件产物](list-file-artifacts.md)。