Skip to content

【分块上传】初始化

适用版本>=v7.0.2405a.20240509

接口说明:【分块上传】第一步,注意事项可参考文件传输概述

请求说明

请求地址配置域名+/graph+/v7/drives/{drive_id}/files/{parent_id}/create_multipart_upload_task
请求方法POST
签名方式WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名)
权限要求更新文件(用户授权) kso.file.write 应用管理文件(应用授权) kso.appdrive.file.write

请求头(Header)

名称是否必填说明
Content-Type固定为: application/json
Wps-Docs-Date取当前时间,示例: Wed, 23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization计算方法参考签名说明
Authorization授权凭证,格式为: Bearer {access_token}

路径参数(Path)

名称类型是否必填说明
drive_idstring驱动盘id,长度不超过1024位
parent_idstring父目录id(根目录时为0),长度不超过1024位

请求体(Body)

名称类型是否必填说明
hashesobject文件哈希信息,用于完整性校验
sumstring哈希结果,长度不超过1024位
typestring哈希类型,仅支持sha256
internalboolean是否内部上传,默认false
namestring文件名,更新文件时忽略(包含后缀,不支持"/:*?"<>|"特殊符号),长度范围[1,240]
on_name_conflictstring文件名冲突行为,fail:失败;rename:重命名;overwrite:覆盖;replace:替换。默认为rename
parent_pathstring[]文件父路径,更新文件时忽略
on_parent_path_conflictstring文件父路径的冲突行为,更新文件时忽略。rename :重命名;overwrite:合并;默认为合并。
sizeinteger文件大小
upload_scenestring文件上传场景,normal_upload:普通文件上传;roaming_upload:漫游文件上传;默认为normal_upload

请求体示例

json
{
  "file_id": "string",
  "hashes": {
    "sum": "string",
    "type": "sha256"
  },
  "internal": false,
  "name": "string",
  "on_name_conflict": "rename",
  "parent_path": ["string"],
  "on_parent_path_conflict": "rename",
  "size": 0,
  "upload_scene": "normal_upload"
}

响应体(Response)

名称类型说明
dataobject初始化分块上传返回体
part_countinteger分块数量
part_sizeinteger分块大小
upload_idstring上传标识,用于后续签发和提交分块上传
codeinteger错误码,参照《错误码说明》
msgstring状态信息
detailstring详细信息

响应体示例

json
{
  "data": {
    "part_count": 0,
    "part_size": 0,
    "upload_id": "string"
  },
  "code": 0,
  "detail": "string",
  "msg": "string"
}