获取个人空间文件列表 - getPersonalFiles
功能介绍
获取个人空间文件列表。
授权信息
当前API调用无需身份策略权限。
URI
POST /koodrive/ose/v1/files/{type}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
是 |
String |
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Authorization |
是 |
String |
该字段存储的是Access Token。调用KooDrive的API使用Token认证,拥有Token就代表拥有某种权限,在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Access Token的获取请参考对应的开发手册,格式参考:Bearer+{access_token} |
|
X-User-Id |
是 |
String |
用户id,用于app鉴权 |
|
X-Date |
是 |
String |
日期,用于app鉴权 |
|
Host |
是 |
String |
地址,用于app鉴权 |
|
X-Traceid |
否 |
String |
消息日志跟踪标识(必须58位) |
|
language |
否 |
String |
国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
pageInfo |
否 |
PageInfo object |
分页信息 |
|
sortInfo |
否 |
FileSortInfo object |
分类信息 |
|
containerId |
是 |
String |
空间标识 |
|
parentFileId |
是 |
String |
文件父目录,枚举值:
|
|
fileType |
否 |
String |
文件类型
|
|
imageProcess |
否 |
String |
图片操作,可用于指定缩略图尺寸,具体取值参照https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html |
|
hidden |
否 |
Boolean |
是否查询隐藏文件(该功能目前只有白名单用户使用) |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
category |
String |
资源类型,固定值为drive#fileList |
|
nextCursor |
String |
分页游标,如果不存在,代表已返回最后一个 |
|
searchCompleted |
Boolean |
是否是完整的搜索 |
|
files |
Array of FileListMetadata objects |
文件列表 |
|
code |
String |
返回码 |
|
msg |
String |
返回信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
文件id |
|
fileName |
String |
文件名,最长250个字符 |
|
fileType |
String |
文件类型,外部输入 10:文件夹 11:智能文件夹(该功能目前只有白名单用户使用) 15:图片 20:视频 26:word 27:excel 28:ppt 30:音频 35:压缩文件 40:应用 45:其他 |
|
mimeType |
String |
内容类型 |
|
favorite |
Boolean |
文件是否被收藏 |
|
recycled |
Boolean |
文件是否被放入回收站 |
|
recycledTime |
String |
放入回收站的时间,文件被回收时返回 |
|
parentFolder |
Array of strings |
父目录ID列表,注意:当前只取第一个父目录Id |
|
properties |
Map<String,String> |
文件公共自定义属性。key-value个数不能超过30个;单个key-value长度不超过124字符 |
|
containers |
Array of strings |
空间标识 |
|
createdTime |
String |
文件创建时间,UTC时间。 |
|
editedTime |
String |
文件修改时间,UTC时间。 |
|
owners |
Array of User objects |
拥有者 |
|
lastEditor |
User object |
最后编辑者 |
|
fileSuffix |
String |
文件后缀,fullFileExtension最后一个字符串 |
|
size |
Integer |
文件大小 |
|
attachments |
Array of FileListAttachment objects |
附件(用途,附件) |
|
downloadLinks |
Array of downLoadLinks objects |
FileProxy文件列表下载地址 |
|
userProperties |
Array of PrivateProperties objects |
用户属性 |
|
sha256 |
String |
文件256 |
|
userCapabilities |
userCapabilities object |
用户权限 |
|
hidden |
Boolean |
是否隐藏 |
|
directlyRecycled |
Boolean |
是否直接删除 |
|
idPath |
String |
文件/文件夹的ID路径 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
category |
String |
类型,drive#user |
|
userId |
String |
华为用户ID |
|
displayName |
String |
用户显示名 |
|
me |
Boolean |
是否是我 |
|
permissionId |
String |
权限id |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
usage |
String |
用途默认:'content'-实体内容、'thumbnail'-缩略图,业务可以扩展该字段 |
|
hash |
String |
Asset关联的资源的hash |
|
sha256 |
String |
Asset关联的资源的sha256 |
|
asset |
FileListAsset object |
资产 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
分片ID |
|
start |
Long |
分片的起始位置,不适用于type={12} |
|
downloadUrl |
EndpointURLMetadata object |
下载url |
|
image |
Array of Images objects |
缩略图信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
attributes |
Map<String,Object> |
类型属性(不限单个属性长度,限制总大小为16K以内) |
|
properties |
Map<String,String> |
扩展属性(不限单个属性长度,限制总大小为16K以内) |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
addChildNodePermission |
Boolean |
是否可以增加子目录/文件 |
|
copyPermission |
Boolean |
是否可以拷贝 |
|
deletePermission |
Boolean |
是否可以删除 |
|
downloadPermission |
Boolean |
是否可以下载内容 |
|
editPermission |
Boolean |
是否可以编辑 |
|
listChildNodePermission |
Boolean |
是否可以list子目录/文件 |
|
removeChildNodePermission |
Boolean |
是否可以移动子目录 |
|
renameFilePermission |
Boolean |
是否可以重命名 |
|
shareFilePermission |
Boolean |
是否可以共享 |
|
uploadPermission |
Boolean |
是否可以上传文件 |
|
viewPermission |
Boolean |
是否可以预览 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
Error object |
错误信息 |
请求示例
查看个人空间IAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b根目录下的文件列表。
POST /koodrive/ose/v1/files/0
Authorization:Bearer+10f88*********4791e9ff
{
"pageInfo": {
"pageSize": "10",
"pageCursor": ""
},
"sortInfo": {
"sortType": "",
"sortDirection": ""
},
"containerId": "IAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b",
"parentFileId": "root",
"fileType": "",
"fileName": ""
}
响应示例
状态码:200
返回文件列表
{
"category" : "drive#fileList",
"nextCursor" : "0|[9-1-0,11-0-1][JzIwMjMtMTItMTNUMDM6MzA6NTkuNTU4Wic=,J0ZpQk02VHhsS2JiSEx4LW54X3FaT2M1bFJBZXEwU0xZeCc=]",
"searchCompleted" : false,
"files" : [ {
"id" : "Fk0n_I_3nVynIIlxGSUdLkYILxIZQ5Yyp",
"fileName" : "AI测试-勿删",
"mimeType" : "application/vnd.huawei-apps.folder",
"fileSuffix" : "",
"recycled" : false,
"parentFolder" : [ "DEUI7pa0C24ArootIAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b" ],
"containers" : [ "IAADfsBFCO6WtAtuAb7e92cde625843cfb7f4ceba802e0b" ],
"properties" : {
"srcFileId" : "Fuyt9uELO9mny6vLWnWpIDqppRh3vzC3p",
"createUser" : "369528171409614001",
"lastEditUser" : "369528171409614001"
},
"owners" : [ {
"category" : "drive#user",
"me" : true,
"permissionId" : "1243622029865966464",
"userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS00MDA4NjAwMDAwNDg3MTY2Ng",
"displayName" : "租户管理员"
} ],
"lastEditor" : {
"category" : "drive#user",
"me" : true,
"permissionId" : "1243622029865966464",
"userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS00MDA4NjAwMDAwNDg3MTY2Ng",
"displayName" : "租户管理员"
},
"fileType" : "10",
"createdTime" : "2023-12-11T09:17:25.529Z",
"editedTime" : "2023-12-11T09:17:25.529Z",
"favorite" : false
} ],
"code" : 0,
"msg" : "成功"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
返回文件列表 |
|
400 |
Bad request |