分片上传文件-预上传
发送初始化请求,以获取上传事务 ID 和分片策略,为上传分片做准备。平台固定以 4MB 的大小对文件进行分片。了解完整的上传文件流程,参考上传文件概述。
注意事项
上传事务 ID 和上传进度在 24 小时内有效。请及时保存和恢复上传。
使用限制
- 该接口不支持并发调用,且调用频率上限为 5 QPS,10000 次/天。否则会返回 1061045 错误码,可通过稍后重试解决。
- 上传文件的大小限制因飞书版本而异,详情参考文件上传、在线预览的大小及格式要求。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/drive/v1/files/upload_prepare |
| HTTP Method | POST |
| 接口频率限制 | 5 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | drive:drive 查看、评论、编辑和管理云空间中所有文件 drive:file 上传、下载文件到云空间 drive:file:upload 上传文件 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
Note 更多云文档接口权限问题,参考常见问题。
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
file_name | string | 是 | 文件的名称 示例值:"test.txt" 数据校验规则: - 最大长度: 250 字符 |
parent_type | string | 是 | 上传点的类型。取固定值 explorer,表示将文件上传至云空间中。 示例值:"explorer" 可选值有: - explorer: 云空间 |
parent_node | string | 是 | 云空间中文件夹的 token。了解如何获取文件夹 token,参考文件夹概述。 示例值:"fldbcO1UuPz8VwnpPx5a92abcef" |
size | int | 是 | 文件的大小,单位为字节。 示例值:1024 数据校验规则: - 最小值: 0 |
请求体示例
json
{
"file_name": "test.txt",
"parent_type": "explorer",
"parent_node": "fldbcO1UuPz8VwnpPx5a92abcef",
"size": 1024
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ upload_id | string | 分片上传事务 ID |
└ block_size | int | 分片大小策略 |
└ block_num | int | 分片的数量 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"upload_id": "7111211691345512356",
"block_size": 4194304,
"block_num": 1
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 200 | 1061001 | internal error. | 服务内部错误,包括超时、错误码没处理等。 注意: 上传文件接口不支持直接将文件上传至知识库,请先将文件上传至文件夹后再移动至知识库。 |
| 400 | 1061002 | params error. | 请检查请求参数是否正确。 |
| 403 | 1061004 | forbidden. | 当前调用身份没有文件或文件夹的阅读或编辑等权限。请参考以下方式解决: - 若上传素材,请确保当前调用身份具有目标云文档的编辑权限 - 若上传文件,请确保当前调用身份具有文件夹的编辑权限 - 若对文件或文件夹进行增删改等操作,请确保调用身份具有足够文档权限: - 对于新建文件接口,调用身份需要有目标文件夹的编辑权限 - 对于复制文件接口,调用身份需要有文件的阅读或编辑权限、并且具有目标文件夹的编辑权限 - 对于移动文件接口,调用身份需要有被移动文件的可管理权限、被移动文件所在位置的编辑权限、目标位置的编辑权限 - 对于删除文件接口,调用身份需要具有以下两种权限之一: - 该应用或用户是文件所有者并且具有该文件所在父文件夹的编辑权限 - 该应用或用户并非文件所有者,但是该文件所在父文件夹的所有者或者拥有该父文件夹的所有权限(full access) 了解开通权限步骤,参考如何为应用开通云文档相关资源的权限。 |
| 500 | 1061022 | file version conflict. | 文件版本号冲突。 |
| 400 | 1061043 | file size beyond limit. | 请检查文件大小以避免超出限制。详情参考飞书帮助中心云盘文件上传大小限制。 |
| 400 | 1061044 | parent node not exist. | parent_node 不存在。请确认上传点 token 是否有误: - 对于上传文件接口,请参考文件夹 token 获取方式确认是否填写了正确的文件夹 token - 对于上传素材接口,请参考上传点类型和上传点 token 确认 parent_node 是否填写正确 |
| 400 | 1061109 | file name cqc not passed. | 请确保上传的文件和文件名合规。 |
| 400 | 1061101 | file quota exceeded. | 租户容量超限,请确保租户有足够容量进行上传。 |
| 400 | 1061061 | user quota exceeded. | 个人容量超限,请确保个人有足够容量进行上传。 |
| 403 | 1061073 | no scope auth. | 没有申请接口权限。 |
| 200 | 1064230 | locked for data migration | 数据迁移中,暂时无法上传。 |
| 400 | 1062507 | parent node out of sibling num. | 云空间目录下挂载数量超过限制(单层1500限制 )。 |
