Skip to main content
Files

File 数据结构

Files API 复用的数据结构和上传限制。

File 对象

上传、查询和列表接口都会返回 File 对象。
字段类型说明
idstringFile ID,前缀为 file_
typestring固定为 "file"
filenamestring存储后的文件名
size_bytesinteger文件大小,单位 byte
mime_typestring上传时提供或根据文件名检测出的 MIME type
downloadableboolean是否可通过 GET /api/v1/cloud/files/{file_id}/content 下载
scopeobject | null文件关联到其他资源时的 scope,例如 { "id": "sess_...", "type": "session" }
metadataobject上传时传入的自定义元数据对象;省略时为 {}
created_atstringUTC 创建时间,RFC 3339 格式
GET /api/v1/cloud/files/{file_id}/content 返回该结构。
字段类型说明
urlstring预签名下载 URL
expires_atstringURL 的 UTC 过期时间,RFC 3339 格式

上传表单字段

POST /api/v1/cloud/files 使用 multipart/form-data。
字段类型必填说明
filefile是文本类文件内容
namestring否存储文件名。不传时使用上传文件名。服务端清理后长度必须为 1-255 byte,且不能是 . 或 ..
metadataJSON string否作为表单字段传入的合法 JSON。原始长度最大 8 KB,省略时为 {}

支持上传的文件类型

上传接口只接受文本类文件。
类别支持的值
MIME type任意 text/* MIME type,以及 application/json、application/xml、application/javascript、application/x-yaml、application/x-toml
文件扩展名.txt、.md、.csv、.json、.xml、.yaml、.yml、.toml、.ini、.conf、.cfg、.env、.log、.html、.htm、.css、.scss、.less、.js、.jsx、.ts、.tsx、.vue、.svelte、.py、.go、.rs、.java、.kt、.scala、.c、.cpp、.cc、.h、.hpp、.rb、.php、.swift、.r、.lua、.pl、.sh、.bash、.zsh、.fish、.ps1、.sql、.graphql、.gql、.proto、.dockerfile、.makefile、.gitignore、.editorconfig、.eslintrc、.prettierrc、.tex、.rst、.adoc、.org、.svg
无扩展名文件名dockerfile、makefile、gemfile、rakefile、procfile、vagrantfile、justfile、brewfile

相关