上传文件

返回响应

🟢200成功

application/json

Body

返回结果集

code

integer

状态码

可选

status

boolean

状态信息

可选

msg

string

返回信息

可选

data

object (FileInfo)

数据

可选

string

文件id

可选

url

string

文件访问地址

可选

size

integer

文件大小，单位字节

可选

filename

string

文件名称

可选

originalFilename

string

原始文件名

可选

basePath

string

基础存储路径

可选

path

string

存储路径

可选

ext

string

文件扩展名

可选

contentType

string

MIME 类型

可选

platform

string

存储平台

可选

thUrl

string

缩略图访问路径

可选

thFilename

string

缩略图名称

可选

thSize

integer

可选

缩略图大小，单位字节

thContentType

string

可选

缩略图 MIME 类型

objectId

string

文件所属对象id

可选

objectType

string

可选

文件所属对象类型，例如用户头像，评价图片

metadata

object (MapString)

文件元数据

可选

userMetadata

object (MapString)

文件用户元数据

可选

thMetadata

object (MapString)

缩略图元数据

可选

thUserMetadata

object (MapString)

缩略图用户元数据

可选

attr

object (Dict)

附加属性字典

可选

fileAcl

object (Object)

可选

文件的访问控制列表，一般情况下只有对象存储支持该功能，支持 String 或对应存储平台的 ACL 对象

//方式一，通过字符串设置通用的 ACL 详情：{@link Constant.ACL }
setFileAcl(ACL.PUBLIC_READ);
//方式二，针对指定存储平台设置更复杂的权限控制，以华为云 OBS 为例
AccessControlList acl = new AccessControlList();
Owner owner = new Owner();
owner.setId("ownerid");
acl.setOwner(owner);
// 保留Owner的完全控制权限（注：如果不设置该权限，该对象Owner自身将没有访问权限）
acl.grantPermission(new CanonicalGrantee("ownerid"), Permission.PERMISSION_FULL_CONTROL);
// 为指定用户设置完全控制权限
acl.grantPermission(new CanonicalGrantee("userid"), Permission.PERMISSION_FULL_CONTROL);
// 为所有用户设置读权限
acl.grantPermission(GroupGrantee.ALL_USERS, Permission.PERMISSION_READ);
setFileAcl(acl);

thFileAcl

object (Object)

可选

缩略图的访问控制列表，一般情况下只有对象存储支持该功能
详情见{@link FileInfo#setFileAcl}

hashInfo

object (HashInfo)

可选

哈希信息类，用来存储各种哈希值

uploadId

string

可选

上传ID，仅在手动分片上传时使用

uploadStatus

integer

可选

上传状态，仅在手动分片上传时使用，1：初始化完成，2：上传完成
{@link org.dromara.x.file.storage.core.constant.Constant.FileInfoUploadStatus}

createTime

string

创建时间

可选

示例

{
  "code": 0,
  "status": false,
  "msg": "",
  "data": {
    "id": "",
    "url": "",
    "size": 0,
    "filename": "",
    "originalFilename": "",
    "basePath": "",
    "path": "",
    "ext": "",
    "contentType": "",
    "platform": "",
    "thUrl": "",
    "thFilename": "",
    "thSize": 0,
    "thContentType": "",
    "objectId": "",
    "objectType": "",
    "metadata": {
      "": ""
    },
    "userMetadata": {
      "": ""
    },
    "thMetadata": {
      "": ""
    },
    "thUserMetadata": {
      "": ""
    },
    "attr": {
      "": {}
    },
    "fileAcl": {},
    "thFileAcl": {},
    "hashInfo": {
      "raw": {
        "": ""
      }
    },
    "uploadId": "",
    "uploadStatus": 0,
    "createTime": ""
  }
}

请求参数

示例代码

返回响应