# 查询文件详情

按文件 ID 查询文件详情。

```text
POST https://moi.matrixorigin.cn/newmoi/catalog/file/info
```

## 调用前准备

先[查询文件列表](list-files.md)或[上传文件](upload-file.md)取得目标文件 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和文件 ID。

下方示例使用：

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

调用者需要文件所属根卷的读取权限。

## 请求体

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `file_id` | string | 是 | 文件 ID。 |

## 请求示例

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

## 成功响应

成功时返回 `200` 和文件信息。调用者需要文件所属根卷的读取权限。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "file_id": "file-123",
    "file_name": "orders.csv",
    "size": 2048
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.file_id` | string | 文件 ID。 |
| `data.file_name` | string | 文件名。 |
| `data.size` | integer | 文件大小，单位为字节。 |

## 错误响应

```json
{
  "code": "ErrNotFound",
  "msg": "对象不存在",
  "data": null
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - `file_id` 缺失或无效。
  - 传入有效的文件 ID。
* - `403`
  - `ErrForbidden`
  - 当前身份没有所属根卷读取权限。
  - 使用有读取权限的凭据，或联系管理员授权。
* - `404`
  - `ErrNotFound`
  - 文件不存在。
  - 检查文件 ID。
* - `500`
  - `ErrServer`
  - 服务无法读取文件信息。
  - 记录请求时间和错误信息后重试；持续失败时联系支持人员。
```

## 后续操作

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