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

时间:2024-12-25 11:11:08

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Traceid

String

消息日志跟踪标识(必须58位)

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鉴权

language

String

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

表2 请求Body参数

参数

是否必选

参数类型

描述

searchType

String

查询类型

  • personal:个人空间

  • team:团队空间

pageInfo

pageInfo object

分页信息

filter

filter object

过滤器

sortInfo

sortInfo object

排序信息

recycled

Boolean

是否查询回收站,不传默认false 枚举值:

  • true:查回收站文件

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

recursived

Boolean

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

imageProcess

String

图片操作,可用于指定缩略图尺寸,具体取值参照https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html

表3 pageInfo

参数

是否必选

参数类型

描述

pageSize

Integer

每页大小,取值范围[1,100]

pageCursor

String

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

表4 filter

参数

是否必选

参数类型

描述

keyWord

String

文件名称,模糊匹配,最长80个字符

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