使用搜索引擎能力检索文件 - Search

功能介绍

用户可以通过文件名和文件类型的方式对整个云空间上所有的文件或文件夹进行全局搜索。

授权信息

当前API调用无需身份策略权限。

URI

POST /koodrive/ose/v1/files/search

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
X-Traceid	否	String	参数解释：业务跟踪id（必须58位）约束限制：不涉及取值范围：长度为58位默认值：不涉及
Authorization	是	String	参数解释：该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} 约束限制：不涉及取值范围：不涉及默认值：不涉及
language	否	String	参数解释：国际化语言标识约束限制：符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语取值范围：符合i18n规范默认取值： en-US
X-User-Id	是	String	参数解释： KooDrive侧用户id，用于app鉴权约束限制：不涉及取值范围：不涉及默认值：不涉及
X-Date	是	String	参数解释：日期，用于app鉴权，格式为yyyyMMdd‘T’HHmmss‘Z’ 约束限制：距当前时间15分钟以内，不能晚于当前时间取值范围：不涉及默认值：不涉及
x-hw-share-folder-id	否	String	参数解释：共享文件夹ID。如果传入了该请求头，则说明当前的操作是在共享文件夹内。约束限制：不涉及取值范围：不涉及默认取值：不涉及

表2 请求Body参数
参数	是否必选	参数类型	描述
searchType	是	String	参数解释：查询类型约束限制：不涉及取值范围： personal：个人空间默认取值：不涉及
pageInfo	是	PageInfo object	参数解释：分页信息约束限制：不涉及取值范围：不涉及默认取值：不涉及
filter	否	filter object	参数解释：过滤条件约束限制：不涉及取值范围：不涉及默认取值：不涉及
sortInfo	否	FileSortInfo object	参数解释：排序信息约束限制：不涉及取值范围：不涉及默认取值：不涉及
recursived	否	Boolean	参数解释：是否递归查询子目录文件约束限制：不涉及取值范围： true false 默认取值： false
imageProcess	否	String	参数解释：图片操作，可用于指定缩略图尺寸约束限制：长度限制300 取值范围：具体取值参照https://support.huaweicloud.com/usermanual-obs/obs_01_0430.html 默认取值： image/resize,m_lfit,h_128,w_128
recycled	否	Boolean	参数解释：回收站查询约束限制：不涉及取值范围： true false 默认取值： false

表3 PageInfo
参数	是否必选	参数类型	描述
pageSize	否	Integer	参数解释：每页文件数量，约束限制：不涉及取值范围：取值范围[1,100] 默认取值：默认100
pageCursor	否	String	参数解释：分页起始游标约束限制：不涉及取值范围：不涉及默认取值：不涉及

表4 filter
参数	是否必选	参数类型	描述
keyWord	否	String	参数解释：文件名约束限制：最大长度250 取值范围：不涉及默认取值：不涉及
containerId	否	String	参数解释：空间ID 约束限制：不涉及取值范围：不涉及默认取值：不涉及
parentFolder	否	String	参数解释：父目录ID 约束限制：不涉及取值范围：不涉及默认取值：不涉及
fileType	否	String	参数解释：文件类型约束限制：不涉及取值范围： 10：文件夹 11：智能文件夹（该功能目前只有白名单用户使用） 15：图片 20：视频 26：word 27：excel 28：ppt 30：音频 35：压缩文件- 40：应用 45：其他默认取值：不涉及
sizeRange	否	String	参数解释：文件大小范围，单位字节约束限制：格式"最小值,最大值",举例：10,200 取值范围：不涉及默认取值：不涉及
updateTimeRange	否	String	参数解释：更新时间范围约束限制：格式举例 "2025-05-16 16:00:00,2025-05-18 15:59:59" 取值范围：不涉及默认取值：不涉及
ownerId	否	String	参数解释：文件属主ID 约束限制：不涉及取值范围：不涉及默认取值：不涉及
fileSuffixList	否	Array of strings	参数解释：文件名后缀约束限制：列表最大长度100 取值范围：不涉及默认取值：不涉及

表5 FileSortInfo
参数	是否必选	参数类型	描述
sortType	否	Integer	参数解释：排序字段约束限制：不涉及取值范围： 1：文件名排序 - 2：文件大小排序 - 3：创建时间排序 - 4：修改时间排序 - 5：回收时间（只针对于回收文件）- 6：文件格式排序默认取值：不涉及
sortDirection	否	Integer	参数解释：排序顺序约束限制：不涉及取值范围： 1：升序 - 2：降序默认取值：不涉及

响应参数

状态码：200

表6 响应Body参数
参数	参数类型	描述
code	Integer	响应码，成功返回0，失败返回错误码
msg	String	成功、错误信息
files	Array of files objects	搜索结果
total	Integer	总数
nextPageCursor	String	下一页起始游标，最后一页值为空

表7 files
参数	参数类型	描述
id	String	文件id
fileSuffix	String	文件后缀
fileName	String	文件名
fileType	String	文件类型
size	String	文件大小
updateTime	String	最后更新时间
namePath	String	名称全路径
idPath	String	id全路径
downloadLinks	Array of downLoadLinks objects	图片类型返回，缩略图地址
containerId	String	空间id
containerType	String	0：部门空间，1：个人空间
favorite	Boolean	空间返回文件是否被当前用户收藏
owner	String	空间返回owner名称
attachments	Attachment object	附件
createTime	String	创建时间
editeTime	String	编辑时间
lastEditor	User object	最后编辑者
mimeType	String	内容类型
ownerId	String	拥有者id
owners	Array of User objects	拥有者
parentFolder	Array of strings	父目录ID列表，注意：当前只取第一个父目录Id
properties	Map<String,Object>	文件公共自定义属性。key-value个数不能超过30个；单个key-value长度不超过124字符
recycled	Boolean	文件是否被放入回收站
sha256	String	sha256
userCapabilities	userCapabilities object	用户权限
userProperties	Array of FileListPrivateProperties objects	用户拓展属性

表8 downLoadLinks
参数	参数类型	描述
usage	String	用途，thumbnail缩略图，content内容
downloadLink	String	图片地址

表9 Attachment
参数	参数类型	描述
usage	String	用途默认：'content'-实体内容、'thumbnail'-缩略图，业务可以扩展该字段
assetId	String	Asset ID
length	Long	文件大小
versionId	String	Asset版本ID
mimeType	String	MIME类型
hash	String	Asset关联的资源的hash
sha256	String	Asset关联的资源的sha256
createdTime	String	数据创建时间
modifiedTime	String	数据最后修改时间
attributes	Map<String,Object>	类型属性
asset	Asset object	资产

**表10** Asset
参数	参数类型	描述
id	String	Asset ID
versionId	String	Asset版本ID
version	Long	版本号
mimeType	String	MIME type
keepPolicy	Integer	历史版本的保存策略 0：自动清理 1：永久保存
state	Integer	数据的状态 0：可用 1：不可用 2：临时 3：留存（不可飞速） 4：待割接
createdTime	String	数据创建时间
modifiedTime	String	数据最后修改时间
lastModifyingUser	String	最后一次修改的用户UPID
resource	Resource object	资源
cipher	Cipher object	密码器
attributes	Map<String,Object>	类型属性（Key部分使用字母开头的字母加数字组合，Value部分禁止使用emoji字符，不限单个属性长度，限制总大小为16K以内），存在字段如下： pictureMetadata：图片属性数据，参见PictureMetadata定义 videoMetadata：视频属性数据，参见VideoMetadata定义 audioMetadata：音频属性数据，参见AudioMetadata定义 contentDisposition：下载附件未指定response-content-disposition，自动使用该字段填充（resource.type=12生效）
properties	Map<String,String>	扩展属性

**表11** Resource
参数	参数类型	描述
id	String	文件资源ID
hash	String	文件资源的hash
length	Long	文件资源的长度
sha256	String	文件的sha256（用于完整性校验）
type	Integer	资源类型 0：密文分片文件 3：明文分片文件 12：明文单片文件
state	Integer	数据的状态 0：可用 1：不可用 2：临时 3：留存（不可飞速） 4：待割接
sliceSize	Long	分片大小
hfek	String	加密文件的fek的hash，用于type={0}
iv	String	加密文件的IV，适用于type={0}
createdTime	String	数据创建时间
modifiedTime	String	数据最后修改时间
objects	Array of SliceObject objects	分片对象，适用于type={0,3}
attributes	Map<String,Object>	类型属性
properties	Map<String,String>	扩展属性

**表12** SliceObject
参数	参数类型	描述
id	String	分片ID
number	Integer	分片序号，从0开始计，不适用于type={12}
start	Long	分片的起始位置，不适用于type={12}
sha256	String	分片的sha256（如果是加密，是指密文的sha256）
length	Long	分片的长度（如果是加密，则是密文长度）
bucket	String	OBS桶信息
createdTime	String	数据创建时间
modifiedTime	String	数据最后修改时间
uploadUrl	EndpointURL object	上传url
downloadUrl	EndpointURL object	下载url
uploadId	String	分段上传ID，适用于type={12}且uploadMode=multipart
attributes	Map<String,Object>	类型属性
properties	Map<String,String>	扩展属性
images	Array of Images objects	缩略图

**表13** EndpointURL
参数	参数类型	描述
url	String	URL
method	String	http method
headers	Map<String,String>	http headers
forms	Map<String,String>	表单参数，适用于type={12}且uploadMode=post
partId	String	分段参数，适用于type={12}且uploadMode=multipart

**表14** Images
参数	参数类型	描述
process	String	文件资源名称
downloadUrl	EndpointURLMetadata object	文件上传或下载的URL结构

**表15** EndpointURLMetadata
参数	参数类型	描述
url	String	URL
method	String	http method

**表16** Cipher
参数	参数类型	描述
algorithm	String	加密算法
hfek	String	加密文件的fek的hash，用于type={0,4}
iv	String	加密文件的IV，适用于type={0,4}
dataType	Integer	数据类型 11：同步盘
keychains	Array of Keychain objects	钥匙串

**表17** Keychain
参数	参数类型	描述
id	String	key的UUID
type	Integer	密钥类型 1：efek 2：zfek 3：sfek
algorithm	String	加密算法
ekey	String	加密后的key

**表18** User
参数	参数类型	描述
category	String	类型，drive#user
userId	String	华为用户ID
displayName	String	用户显示名
me	Boolean	是否是我
permissionId	String	权限id

**表19** userCapabilities
参数	参数类型	描述
addChildNodePermission	Boolean	是否可以增加子目录/文件
copyPermission	Boolean	是否可以拷贝
deletePermission	Boolean	是否可以删除
downloadPermission	Boolean	是否可以下载内容
editPermission	Boolean	是否可以编辑
listChildNodePermission	Boolean	是否可以list子目录/文件
removeChildNodePermission	Boolean	是否可以移动子目录
renameFilePermission	Boolean	是否可以重命名
shareFilePermission	Boolean	是否可以共享
uploadPermission	Boolean	是否可以上传文件
viewPermission	Boolean	是否可以预览

**表20** FileListPrivateProperties
参数	参数类型	描述
properties	Map<String,String>	扩展属性（不限单个属性长度，限制总大小为16K以内）

请求示例

搜索文件请求示例。

POST /koodrive/ose/v1/files/search

Authorization:Bearer+10f88*********4791e9ff
{
  "searchType" : " personal/team",
  "pageInfo" : {
    "pageSize" : 100,
    "pageCursor" : 1
  },
  "filter" : {
    "keyWord" : "材料",
    "containerId" : "123456",
    "parentFolder" : "1",
    "fileType" : "1",
    "sizeRang" : "1024,2048",
    "updateTimeRange" : "2023-11-02,2023-11-21",
    "ownerId" : "归属用户id"
  }
}

响应示例

状态码：200

搜索结果

{
  "files" : [ {
    "id" : "Fu2A5BQZ1qUk3h1tU6ZlAS66swzlN9mnJ",
    "sha256" : "57eafb818ad716aa11b443fb9fc2c1f23875f0c8da49035a8ca98136e4525632",
    "fileName" : "KooDrive服务介绍.docx",
    "fileSuffix" : "docx",
    "fileType" : "26",
    "size" : "705395",
    "updateTime" : "2024-12-25T06:41:22.873Z",
    "idPath" : "DFcz6PEuDwIArootIAAFWbRXM-jxLg8CA1578177668157825025",
    "downloadLinks" : [ {
      "usage" : "content",
      "downloadLink" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/18ad967c9af047fd8b909ed163c0fdb6086?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27KooDrive%25E6%259C%258D%25E5%258A%25A1%25E4%25BB%258B%25E7%25BB%258D.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250103T023324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20250103%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=e518a982307ef9b6d6e4bd8788e421d3488f58f3ed79eb3ab42702ac5c3d7513"
    }, {
      "usage" : "thumbnail",
      "downloadLink" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/18ad967c9af047fd8b909ed163c0fdb6086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27KooDrive%25E6%259C%258D%25E5%258A%25A1%25E4%25BB%258B%25E7%25BB%258D.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250103T023324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20250103%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=ad55a09e66ddd32c6f9b3cce08c7c9a867c7a579a41200f415fb2918de1ab473"
    } ],
    "teamName" : "fdsgdsf",
    "teamId" : "1578175198769733633",
    "containerId" : "IAAFWbRXM-jxLg8CA1578177668157825025",
    "containerType" : "0",
    "favorite" : false,
    "owner" : "hid42638091",
    "ownerId" : "1568722386902108288",
    "properties" : {
      "localCreatedAt" : "",
      "localUpdatedAt" : "",
      "createUser" : "1568722386902108288",
      "lastEditUser" : "1568722386902108288",
      "auditResult" : "{\"auditDetail\":\"{}\",\"auditLevel\":10,\"auditResult\":1}"
    },
    "attachments" : [ {
      "assetId" : "1584078561541652992",
      "asset" : {
        "id" : "1584078561541652992",
        "versionId" : "1584078561541652993",
        "version" : 49923,
        "mimeType" : "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
        "state" : 0,
        "createdTime" : "2024-12-25T06:41:20.050Z",
        "modifiedTime" : "2024-12-25T06:41:20.050Z",
        "resource" : {
          "id" : "1584078561810055808",
          "length" : 705395,
          "sha256" : "57eafb818ad716aa11b443fb9fc2c1f23875f0c8da49035a8ca98136e4525632",
          "object" : {
            "id" : "18ad967c9af047fd8b909ed163c0fdb6086",
            "start" : 0,
            "downloadUrl" : {
              "url" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/18ad967c9af047fd8b909ed163c0fdb6086?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27KooDrive%25E6%259C%258D%25E5%258A%25A1%25E4%25BB%258B%25E7%25BB%258D.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250103T023324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20250103%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=e518a982307ef9b6d6e4bd8788e421d3488f58f3ed79eb3ab42702ac5c3d7513",
              "method" : "GET"
            },
            "images" : [ {
              "process" : "image/resize,m_lfit,h_128,w_128",
              "downloadUrl" : {
                "url" : "https://b10-obs-ykj-uat-01.obs.cidc-rp-2006.joint.cmecloud.cn/18ad967c9af047fd8b909ed163c0fdb6086?x-image-process=image%2Fresize%2Cm_lfit%2Ch_128%2Cw_128&response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27KooDrive%25E6%259C%258D%25E5%258A%25A1%25E4%25BB%258B%25E7%25BB%258D.docx&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250103T023324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=MKRISPBZAJWFHNBJ5WLB%2F20250103%2Fcidc-rp-2006%2Fs3%2Faws4_request&X-Amz-Signature=ad55a09e66ddd32c6f9b3cce08c7c9a867c7a579a41200f415fb2918de1ab473",
                "method" : "GET"
              }
            } ]
          }
        },
        "attributes" : {
          "fileName" : "KooDrive服务介绍.docx",
          "localCreatedAt" : "",
          "createdBy" : "667706171d1c4ef2a4d7464f3656066c",
          "resource" : {
            "id" : "1584078561810055808",
            "object" : {
              "bucket" : "b10-obs-ykj-uat-01",
              "objectId" : "18ad967c9af047fd8b909ed163c0fdb6086"
            }
          },
          "localUpdatedAt" : ""
        }
      },
      "versionId" : "1584078561541652993",
      "attributes" : {
        "fileName" : "KooDrive服务介绍.docx",
        "localCreatedAt" : "",
        "createdBy" : "667706171d1c4ef2a4d7464f3656066c",
        "resource" : {
          "id" : "1584078561810055808",
          "object" : {
            "bucket" : "b10-obs-ykj-uat-01",
            "objectId" : "18ad967c9af047fd8b909ed163c0fdb6086"
          }
        },
        "localUpdatedAt" : ""
      },
      "hash" : "57eafb818ad716aa11b443fb9fc2c1f23875f0c8da49035a8ca98136e4525632",
      "length" : 705395,
      "mimeType" : "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "usage" : "content",
      "sha256" : "57eafb818ad716aa11b443fb9fc2c1f23875f0c8da49035a8ca98136e4525632",
      "createdTime" : "2024-12-25T06:41:20.050Z",
      "modifiedTime" : "2024-12-25T06:41:20.050Z"
    } ],
    "createdTime" : "2024-12-25T06:41:19.794Z",
    "editedTime" : "2024-12-25T06:41:22.873Z",
    "lastEditor" : {
      "category" : "drive#user",
      "me" : true,
      "permissionId" : "1570905506917367936",
      "userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS02Njc3MDYxNzFkMWM0ZWYyYTRkNzQ2NGYzNjU2MDY2Yw",
      "displayName" : "hid42638091"
    },
    "mimeType" : "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "owners" : [ {
      "category" : "drive#user",
      "me" : true,
      "permissionId" : "1570905506917367936",
      "userId" : "NDEzMDA4NjAwMDAwMjc0MTY2NS02Njc3MDYxNzFkMWM0ZWYyYTRkNzQ2NGYzNjU2MDY2Yw"
    } ],
    "parentFolder" : [ "DFcz6PEuDwIArootIAAFWbRXM-jxLg8CA1578177668157825025" ],
    "recycled" : false,
    "userProperties" : {
      "properties" : {
        "hidden" : "false"
      }
    },
    "userCapabilities" : {
      "addChildNodePermission" : true,
      "copyPermission" : true,
      "deletePermission" : true,
      "downloadPermission" : true,
      "editPermission" : true,
      "listChildNodePermission" : true,
      "removeChildNodePermission" : true,
      "renameFilePermission" : true,
      "shareFilePermission" : true,
      "uploadPermission" : true,
      "viewPermission" : true
    }
  } ],
  "total" : 1,
  "code" : 0,
  "msg" : "成功"
}

状态码

状态码	描述
200	搜索结果

父主题：文件管理

上一篇：清空回收站 - clearRecycleFile

下一篇：统计文件夹 - StatsDir

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试