创建分片上传任务
说明
BIMFACE提供分片上传功能,可以将待上传的文件切分为多个碎片(Part)分别上传,完成上传后再调用合并分片生成文件 (opens new window)接口,将碎片合并为完整的文件。
适用场景:
- 当上传的文件较大,文件大小超过5GB时,建议使用分片上传,BIMFACE支持分片上传的文件大小为0~48.8T,单个分片(Part)大小不超过5GB,最后一个Part的大小无限制;
- 当网络环境较差时,建议使用分片上传,可并行上传多个分片以加快上传速度,若上传失败,您仅需重传失败的Part。
流程说明:
- 将待上传文件按照一定大小进行分片;
- 使用创建分片上传任务 (opens new window)初始化一个分片上传任务,获取文件id;
- 使用获取分片上传url (opens new window)接口,获取每个Part的上传链接,您需自行使用链接上传每个分片,需保证切片顺序和partNumber一致;
- 如果希望终止上传任务,可调用终止分片上传任务 (opens new window)接口,成功上传的Part会一并删除;
- 当所有Part上传完毕后,使用合并分片生成文件 (opens new window)接口,将碎片合并为完整的文件。
参数
Authorization * | Bearer {accessToken} | string |
*为必填项
Path
*为必填项
Body
length* | 文件大小 | int64 |
name* | 文件名 | string |
parentId | |
parentPath | 父文件夹路径(parentId 和 parentPath 必须二选一) | string |
sourceId | 调用方的文件源ID,不能重复 | string |
响应
HTTP代码 | 说明 | 类型 |
200 | OK | GeneralResponseV1«InitMultipartUploadDTO» |
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
200响应参数
GeneralResponseV1«InitMultipartUploadDTO»
名称 | 说明 | 类型 |
code | 状态代码 | string |
data | 返回数据 | InitMultipartUploadDTO |
sourceId | 调用方的文件源ID | string |
uploadId | 云存储的uploadId, 标识该分片上传事件 | string |
createTime | 开始上传的初始化时间 | date-time |
parentPath | 父文件夹路径 | string |
length | 总文件大小 | int64 |
name | 文件名 | string |
appKey | appKey | string |
id | 初始化分片的文件id | string |
used | 标记分片上传的记录是否已经使用 | boolean |
projectId | 项目id | string |
objectId | 对象id | string |
parentId | 父文件夹id | string |
message | 提示信息 | string |
消耗
生成
HTTP请求示例
请求 path
请求 body
HTTP响应示例
响应 200