文档

DescribeFileUploadSignedUrl - 获取上传文件需要的签名

获取上传文件需要的签名。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Filenamestring
  • 原始的文件名称。
  • 当以"/"结尾时,创建一个空文件夹,支持多级子文件夹。创建文件夹时,不返回文件签名,自动完成创建。
wlop29.jpg
Sizelong

文件大小,单位字节。

41836
SpaceIdstring

服务空间 ID。

mp-0e16bb12-14af-****-b24c-5ac1a9a7bb9f
ContentTypestring

文件类型:.pdf .xls .xlsx .doc .docx .ppt .pptx .txt

png
FileIdstring

自定义上传文件路径,支持多级目录,路径支持字母、数字、中文、横线、下横线、点符号,总长度不超过 1024,必须以"/"开头,例如: /abc/edf/hello.jpg

说明
  • 当该文件路径已存在文件时会直接覆盖
  • 另外也支持传入 fileId 或者文件 url 覆盖已有文件
  • /abc/edf/hello.jpg

    返回参数

    名称类型描述示例值
    object
    SignUrlstring

    上传文件地址。

    https://bsppub.oss-cn-shanghai.aliyuncs.com/FBPSBVMO-myspace/41552d60-52de-xxx-a713-43e879b0717a.JPG?OSSAccessKeyId=LTAIk****dtFueLA&Expires=1582152512&Signature=sek1B0Xm2r***tNvfX9tX%2BBJxA%3D
    RequestIdstring

    请求 ID。

    E9A50E1B-5ECE-42D4-B261-C07D1BBE68DE
    Idstring

    文件唯一标识。

    2fada31e-8fa5-****-b595-9698cd6b5f06
    OssCallbackUrlstring

    上传结果回调地址。

    https://api.next.bspapp.com/oss_upload_callback
    Overwriteboolean

    含义是该上传请求是否会覆盖文件。

    • true:覆盖。
    • false:不覆盖。
    true

    在获取到上传文件地址 SignUrl 之后,需要使用 PUT 对该地址上传文件。 PUT 请求必须在 headers 携带回调地址参数,该参数构造方法如下:

    • 第一步:构造字符串 {"callbackUrl":"....","callbackBody":"{\"fileId\":\"....\",\"spaceId\":\"....\"}","callbackBodyType":"application/json"} 分别将参数 OssCallbackUrl、Id 以及 SpaceId 替换到上面的空缺部分。
    • 第二步:对上述字符串进行 base64 编码。
    • 第三步:在上传文件时添加 header x-oss-callback,值为第二步计算得到的字符串。

    注意 请求参数 ContentType 也是签名计算的一部分,因此在上传文件时您需要添加 header Content-Type,并确保值和入参一致。

    示例

    正常返回示例

    JSON格式

    {
      "SignUrl": "https://bsppub.oss-cn-shanghai.aliyuncs.com/FBPSBVMO-myspace/41552d60-52de-xxx-a713-43e879b0717a.JPG?OSSAccessKeyId=LTAIk****dtFueLA&Expires=1582152512&Signature=sek1B0Xm2r***tNvfX9tX%2BBJxA%3D",
      "RequestId": "E9A50E1B-5ECE-42D4-B261-C07D1BBE68DE",
      "Id": "2fada31e-8fa5-****-b595-9698cd6b5f06",
      "OssCallbackUrl": "https://api.next.bspapp.com/oss_upload_callback",
      "Overwrite": true
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-06-01OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    出参OpenAPI 返回结构发生变更
    2023-04-20OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:FileId
    • 本页导读 (0)
    文档反馈