文档首页/ 云空间服务 KooDrive/ API参考/ API/ 获取文件列表/ 获取个人空间文件列表
更新时间：2024-07-30 GMT+08:00
查看PDF
分享

获取个人空间文件列表

功能介绍

获取个人空间文件列表。

URI

POST /koodrive/ose/v1/files/{type}

表1 路径参数

参数

是否必选

参数类型

描述

type

是

String

  • 0：个人空间

  • 1：个人回收站

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token}

X-Traceid

否

String

消息日志跟踪标识（必须58位）

language

否

String

国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语
表3 请求Body参数

参数

是否必选

参数类型

描述

pageInfo

否

PageInfo object

分页信息

sortInfo

否

FileSortInfo object

分类信息

containerId

是

String

空间标识

parentFileId

是

String

文件父目录，枚举值：

  • root：普通文件系统根目录

  • sbox：保险箱文件系统根目录

fileType

否

String

文件类型

  • 10：文件夹

  • 15：图片

  • 20：视频

  • 26：word

  • 27：excel

  • 28：ppt

  • 30：音频

  • 35：压缩文件

  • 40：应用

  • 45：其他
表4 PageInfo

参数

是否必选

参数类型

描述

pageSize

否

Integer

每页文件数量，默认100

pageCursor

否

String

分页起始游标
表5 FileSortInfo

参数

是否必选

参数类型

描述

sortType

否

Integer

排序字段

  • 1：文件名排序

  • 2：文件大小排序

  • 3：创建时间排序

  • 4：修改时间排序

  • 5：回收时间（只针对于回收文件）

  • 6：文件格式排序

sortDirection

否

Integer

排序顺序

  • 1：升序

  • 2：降序

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

category

String

资源类型，固定值为drive#fileList

nextCursor

String

分页游标，如果不存在，代表已返回最后一个

searchCompleted

Boolean

是否是完整的搜索

files

Array of FileListMetadata objects

文件列表

code

String

返回码

msg

String

返回信息
表7 FileListMetadata

参数

参数类型

描述

id

String

文件id

fileName

String

文件名，最长80个字符

fileType

String

文件类型，外部输入

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

附件（用途，附件），只有风控服务appid返回

downloadLinks

Array of DownLoadLink objects

FileProxy文件列表下载地址

userProperties

FileListPrivateProperties object

用户属性
表8 User

参数

参数类型

描述

category

String

类型，drive#user

枚举值：

  • drive#user

userId

String

华为用户ID

displayName

String

用户显示名

me

Boolean

是否是我

permissionId

String

权限id
表9 FileListAttachment

参数

参数类型

描述

usage

String

用途默认：'content'-实体内容、'thumbnail'-缩略图，业务可以扩展该字段

hash

String

Asset关联的资源的hash

sha256

String

Asset关联的资源的sha256

asset

FileListAsset object

资产
表10 FileListAsset

参数

参数类型

描述

resource

FileListResource object

资源

mimeType

String

MIME type
表11 FileListResource

参数

参数类型

描述

object

FileListSliceObject object

分片对象，适用于type={0,3}
表12 FileListSliceObject

参数

参数类型

描述

id

String

分片ID

start

Long

分片的起始位置，不适用于type={12}

downloadUrl

EndpointURLMetadata object

下载url

image

Array of Images objects

缩略图信息
表13 Images

参数

参数类型

描述

process

String

文件资源名称

downloadUrl

EndpointURLMetadata object

文件上传或下载的URL结构
表14 EndpointURLMetadata

参数

参数类型

描述

url

String

URL

method

String

http method
表15 DownLoadLink

参数

参数类型

描述

usage

String

用途，thumbnail缩略图，content内容

downloadLink

String

图片地址
表16 FileListPrivateProperties

参数

参数类型

描述

properties

Map<String,String>

扩展属性（不限单个属性长度，限制总大小为16K以内）

状态码： 400

表17 响应Body参数

参数

参数类型

描述

error

Error object

错误信息
表18 Error

参数

参数类型

描述

errorData

errorData object

异常时候返回给访问者的扩展数据

errorDetail

Array of ErrorMsg objects

错误链

code

Integer

http状态码

description

String

http状态信息
表19 errorData

参数

参数类型

描述

conflictFileId

String

冲突文件ID
表20 ErrorMsg

参数

参数类型

描述

domain

String

域

reason

String

错误原因

errorCode

String

系统内部错误编码，参见错误码规范

description

String

错误描述信息

errorPos

String

错误位置类型

errorParam

String

错误位置

请求示例

查看个人空间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
父主题： 获取文件列表