云盘服务 KOODRIVE-使用搜索引擎能力检索文件:请求参数

时间:2024-01-05 14:30:29

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

x-trace-id

String

消息日志跟踪标识

Authorization

String

格式“Bearer {app_access_token}”,需传入应用级token,用于应用服务端调用,通过创建应用时获得的clientid及clientSecret调用接口获取

language

String

国际化语言标识,符合i18n规范,如zh-CN表示简体中文,en-US表示美式英语,不传默认美式英语

X-Csrf-Token

String

CSRF Token

表2 请求Body参数

参数

是否必选

参数类型

描述

searchType

String

查询类型:个人空间、团队空间

pageInfo

pageInfo object

分页信息

filter

filter object

过滤器

sortInfo

sortInfo object

排序信息

recycled

Boolean

是否查询回收站,枚举值:

  • true:查回收站文件

  • false:查对应空间非回收站

缺省值:false

recursived

Boolean

是否递归查询子目录文件,默认false

表3 pageInfo

参数

是否必选

参数类型

描述

pageSize

Integer

每页大小

最小值:1

最大值:100

pageCursor

String

起始游标,为空时从第一页开始查询

表4 filter

参数

是否必选

参数类型

描述

keyWord

String

文件名称,模糊匹配

最小长度:1

最大长度:255

containerId

String

空间id,指定父目录时必传

parentFolder

String

父目录

fileType

String

文件类型,枚举值 /** * 文件夹 / FOLDER("10"), /* * 图片 / PICTURE("15"), /* * 视频 / VIDEO("20"), /* * word / WORD("26"), /* * excel / EXCEL("27"), /* * ppt / PPT("28"), /* * 音频 / AUDIO("30"), /* * 压缩文件 / ARCHIVE("35"), /* * 应用 / APPLICATION("40"), /* * 其他 */ OTHER("45");

updateTimeRange

String

最后更新时间区间

ownerId

String

文件所有者

表5 sortInfo

参数

是否必选

参数类型

描述

sortType

String

枚举类型:

  • fileName:文件名

  • size:文件大小

  • type:文件格式

  • updateTime:最后更新时间

  • createTime:创建时间

  • recycledTime:删除时间

  • fileSuffix:文件格式小类

sortDirection

String

枚举类型:

  • desc:降序

  • asc:升序列

support.huaweicloud.com/api-koodrive/Search.html