Skip to content

文件秒传

适用版本>=v7.0.2406a.20240613

接口说明:文件秒传,不保证上传后的文件秒传一定能命中

请求说明

请求地址配置域名+/graph+/v7/drives/{drive_id}/files/{parent_id}/rapid_upload
请求方法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)

名称类型是否必填说明
file_idstring<= 1024 characters,更新上传时指定文件id(不推荐编辑更新场景使用秒传)
hashesobject[]文件哈希信息,用于判断是否支持秒传,<= 1024 items
sumstring哈希结果
typestring哈希类型,目前仅支持sha256
namestring文件名,更新文件时忽略(包含后缀,不支持"/:*?"<>|"特殊符号),长度范围[1,240]
on_name_conflictstring文件名冲突行为,fail:失败;rename:重命名;overwrite:覆盖;replace:替换。默认为rename
parent_pathstring[]<= 1024 items,items <= 1024 characters,文件父路径,不存在则创建
on_parent_path_conflictstring文件父路径的冲突行为,更新文件时忽略。rename :重命名;overwrite:合并;默认为合并。
sizeinteger文件大小

请求体示例

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

响应体(Response)

名称类型说明
dataobject
created_byobject创建者信息
avatarstring创建者头像,<= 1024 characters
company_idstring创建者企业id,<= 1024 characters
idstring创建者id,<= 1024 characters
namestring创建者名称,<= 1024 characters
typestring创建者身份类型,user:用户
ctimeinteger创建时间,时间戳,单位为秒
drive_idstring驱动盘id
hashobject文件哈希信息
sumstring哈希结果
typestring哈希类型,固定为s2s
idstring文件id
link_idstring链接id
link_urlstring链接url
modified_byobject修改者信息
avatarstring修改者头像,<= 1024 characters
company_idstring修改者企业id,<= 1024 characters
idstring修改者id,<= 1024 characters
namestring修改者名称,<= 1024 characters
typestring修改者身份类型,user:用户
mtimeinteger修改时间,时间戳,单位为秒
namestring文件名
parent_idstring父目录id
sizeinteger文件大小
typestringEnum: "folder" "file" 文件类型
versioninteger文件版本号
codeinteger错误码,参照《错误码说明》
msgstring状态信息
detailstring详细信息

响应体示例

{
    "code": 0,
    "data": {
        "id": "string",
        "drive_id": "string",
        "mtime": 0,
        "hash": {
            "type": "s2s",
            "sum": "string"
        },
        "link_url": "string",
        "link_id": "string",
        "parent_id": "string",
        "created_by": {
            "id": "string",
            "name": "string",
            "avatar": "string",
            "company_id": "string",
            "type": "user"
        },
        "modified_by": {
            "id": "string",
            "name": "string",
            "avatar": "string",
            "company_id": "string",
            "type": "user"
        },
        "size": 0,
        "version": 0,
        "type": "file",
        "name": "string",
        "ctime": 0
    },
    "detail": "string",
    "msg": "string"
}