Skip to content

GET /api/v1/projects/{projectId}/files

GET/api/v1/projects/{projectId}/files

项目文件列表(需 viewer 及以上;prefix 必须以 `<项目slug>/` 开头)

projectoperationId: projectFileList

请求参数

名称类型位置必填说明
projectIdstringpath是项目 ID(UUID)。携带 `X-API-Key` 时按 API Key scope 鉴权,否则按 JWT + 项目成员角色鉴权
prefixstringquery否—

请求示例

cURL
curl -X GET 'http://localhost:8080/api/v1/projects/{projectId}/files' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: <PROJECT_API_KEY>'
# 也可使用登录会话:-H 'Authorization: Bearer <JWT>'
JavaScript
const res = await fetch('http://localhost:8080/api/v1/projects/{projectId}/files', {
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'X-API-Key': '<PROJECT_API_KEY>'
  },
});
const data = await res.json();
Python
import requests

res = requests.get(
    'http://localhost:8080/api/v1/projects/{projectId}/files',
    headers={'Accept': 'application/json', 'X-API-Key': '<PROJECT_API_KEY>'}
)
print(res.json())

响应

200成功

application/json

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "size": {
            "type": "integer",
            "format": "int64"
          },
          "content_type": {
            "type": "string"
          },
          "last_modified": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    }
  }
}
400请求参数错误

application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "not_found"
    },
    "message": {
      "type": "string",
      "example": "资源不存在"
    }
  }
}
403无权限(未通过 RBAC 或 2FA)

application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "not_found"
    },
    "message": {
      "type": "string",
      "example": "资源不存在"
    }
  }
}

在线调试

在线调试
凭证仅保存在当前页面内存中
自定义请求 Header