Skip to main content
Files

查询 File

Forward Files API 接口说明。

描述

根据 File ID 获取单个 File 的元数据。

路径

GET /api/v1/forward/files/{file_id}

请求头

头部必选说明
Authorization是Bearer <PAT 或 SAT>

路径参数

参数类型必选说明
file_idstring是要查询的 File ID。

查询参数

参数类型必选说明
identity_idstring否仅在操作 Identity 归属资源时使用;PAT 可通过 Query 显式传入,不传时为管理员视角;SAT 由凭证确定归属,任何 SAT 显式携带该参数(包括空值)返回 HTTP 400。详见 Identity 归属。

示例请求

curl -X GET "https://api.qoder.com/api/v1/forward/files/file_xxx" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

示例响应

HTTP 200 OK
{
  "id": "file_xxx",
  "type": "file",
  "filename": "report.pdf",
  "size_bytes": 1024,
  "mime_type": "application/pdf",
  "created_at": "2026-07-23T10:00:00Z",
  "updated_at": "2026-07-23T10:00:00Z",
  "downloadable": true,
  "scope": null,
  "metadata": {"source": "console"},
  "identity_id": null
}

响应字段

响应为 File 对象。

错误码

HTTPtype触发条件
400invalid_request_error请求体、路径参数或查询参数非法;包括 SAT 显式携带 Query identity_id(含空值)。
401authentication_error缺少或无效的认证令牌。
403permission_error管理员 Scope 发生 Owner mismatch,或下游服务拒绝访问。
404not_found_errorFile 不存在或在当前 Identity Scope 不可见;PAT 指定的 Identity 无效、已禁用、已删除或越权。
500/502/503api_errorForward 或依赖服务失败。