Skip to content

请求文件上传信息

适用版本>=v7.0.2411a.20241114

接口说明:请求文件上传信息

请求说明

请求地址配置域名+/openapi+/v7/drives/{drive_id}/files/{parent_id}/request_upload
请求方法POST
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求查询和管理文件(应用授权) kso.file.readwrite
查询和管理文件(用户授权) kso.file.readwrite

请求头(Header)

Header参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称参数类型是否必填说明
drive_idstring驱动盘id,<= 1024 characters
parent_idstring父文件(夹)id(根目录时为0),<= 1024 characters

请求体(Body)

名称类型是否必填说明
namestring文件名,包含后缀,不支持"/:*?"<>|"特殊符号,字符串大小[1,240]
sizeint64文件大小
hashesobject[]文件哈希信息,用于完整性校验,<= 1024 items
sumstring哈希结果
typestring哈希类型,仅支持sha256
parent_pathstring[]文件父路径,不存在则创建(parentid下子目录路径),<= 1024 items [ items <= 1024 characters ]
on_name_conflictstring文件名冲突行为,fail:失败;rename:重命名;overwrite:覆盖;replace:替换。默认为rename
on_parent_path_conflictstring文件父路径的冲突行为,更新文件时忽略。rename :重命名;overwrite:合并;默认为合并。
methodstring文件上传方法,私有化默认为WPS3_POST,Enum: “PUT”,“WPS3 POST”
file_idstring更新上传时指定文件id,<= 1024 characters

请求体示例

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

响应体(Response)

名称类型说明
dataobject请求文件上传信息返回
idstring上传标识,用于提交文件上传完成
store_requestobject上传实体文件中请求信息
store_response_keysobject上传实体文件响应中的回传字段,调用者需要根据这些字段从响应中取出回传信息,并在提交文件上传完成时进行回传
codeint错误码
msgstring状态信息
detailstring详细信息

响应体示例

json
{
  "code": 0,
  "data": {
    "id": "eyJuYW1lIjoiZG93bmxvYWQgKDEpLnBkZiIsInNpemUiOjEsImhhc2hlcyI6bnVsbCwicGFyZW50X3BhdGgiOm51bGwsIm9uX25hbWVfY29uZmxpY3QiOiJyZW5hbWUiLCJtZXRob2QiOiJQT1NUIiwiaW50ZXJuYWwiOmZhbHNlLCJmaWxlX2lkIjoiMCJ9",
    "store_request": {
      "method": "POST",
      "url": "https://10.13.80.140/path3/path4/minio/wpsfile/yundoc/f6cdERzn4UBoVm1mJZIrntvtUS2191959075389440",
      "headers": [
        {
          "name": "Content-Type",
          "value": ""
        },
        {
          "name": "X-Amz-Date",
          "value": "20230713T015340Z"
        },
        {
          "name": "Authorization",
          "value": "AWS4-HMAC-SHA256 Credential=KpuUOVra7m0lN4Vx/20230713/us-east-1/s3/aws4_request, SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date, Signature=2aa5915d0f6259fe44f146ff7471744cd028940f9141bbbdb511581782b22baa"
        },
        {
          "name": "X-Amz-Content-Sha256",
          "value": "UNSIGNED-PAYLOAD"
        }
      ],
      "body_params": []
    },
    "store_response_keys": {
      "header_keys": ["X-Wps3-Info-Token"],
      "body_keys": []
    }
  },
  "detail": "",
  "msg": "ok"
}