文件秒传
适用版本>=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_id | string | 是 | 驱动盘id,长度不超过1024位 |
| parent_id | string | 是 | 父目录id(根目录时为0),长度不超过1024位 |
请求体(Body)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| file_id | string | 否 | <= 1024 characters,更新上传时指定文件id(不推荐编辑更新场景使用秒传) |
| hashes | object[] | 是 | 文件哈希信息,用于判断是否支持秒传,<= 1024 items |
| ∟ sum | string | 是 | 哈希结果 |
| ∟ type | string | 是 | 哈希类型,目前仅支持sha256 |
| name | string | 否 | 文件名,更新文件时忽略(包含后缀,不支持"/:*?"<>|"特殊符号),长度范围[1,240] |
| on_name_conflict | string | 否 | 文件名冲突行为,fail:失败;rename:重命名;overwrite:覆盖;replace:替换。默认为rename |
| parent_path | string[] | 否 | <= 1024 items,items <= 1024 characters,文件父路径,不存在则创建 |
| on_parent_path_conflict | string | 否 | 文件父路径的冲突行为,更新文件时忽略。rename :重命名;overwrite:合并;默认为合并。 |
| size | integer | 是 | 文件大小 |
请求体示例
{
"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)
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | |
| ∟ created_by | object | 创建者信息 |
| ∟ ∟ avatar | string | 创建者头像,<= 1024 characters |
| ∟ ∟ company_id | string | 创建者企业id,<= 1024 characters |
| ∟ ∟ id | string | 创建者id,<= 1024 characters |
| ∟ ∟ name | string | 创建者名称,<= 1024 characters |
| ∟ ∟ type | string | 创建者身份类型,user:用户 |
| ∟ ctime | integer | 创建时间,时间戳,单位为秒 |
| ∟ drive_id | string | 驱动盘id |
| ∟ hash | object | 文件哈希信息 |
| ∟ ∟ sum | string | 哈希结果 |
| ∟ ∟ type | string | 哈希类型,固定为s2s |
| ∟ id | string | 文件id |
| ∟ link_id | string | 链接id |
| ∟ link_url | string | 链接url |
| ∟ modified_by | object | 修改者信息 |
| ∟ ∟ avatar | string | 修改者头像,<= 1024 characters |
| ∟ ∟ company_id | string | 修改者企业id,<= 1024 characters |
| ∟ ∟ id | string | 修改者id,<= 1024 characters |
| ∟ ∟ name | string | 修改者名称,<= 1024 characters |
| ∟ ∟ type | string | 修改者身份类型,user:用户 |
| ∟ mtime | integer | 修改时间,时间戳,单位为秒 |
| ∟ name | string | 文件名 |
| ∟ parent_id | string | 父目录id |
| ∟ size | integer | 文件大小 |
| ∟ type | string | Enum: "folder" "file" 文件类型 |
| ∟ version | integer | 文件版本号 |
| code | integer | 错误码,参照《错误码说明》 |
| msg | string | 状态信息 |
| detail | string | 详细信息 |
响应体示例
{
"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"
}