全部产品

文件搜索

更新时间:2020-08-06 15:47:33

目前支持情况 PDSPath(✔️), OSSPath(❌)

用户可以通过/file/search接口搜索自己drive下的文件

请求

POST /v2/file/search

请求参数字段说明:

名称 位置 类型 必选 说明
Authorization header string access_token
drive_id body string 待搜索的drive ID
query body string 查询语法字符串,详细说明见下文。最大长度4096
order_by body string 搜索结果排序的语法,详细说明见下文。最大长度128
limit body string 返回数据最大条数,范围:[0-100],默认:50
marker body string 查询起始标识,下发了marker参数则忽略query

query规则说明:

  1. 支持的数据类型:

    a. 基本类型:long、string、bool、double

    b. 复合类型:array,date(时间类型,ISO时间: “2019-08-13T06:19:22.870Z”)

  2. 基本类型支持的搜索:

    a. long: =, <, >, <=, >=

    b. string: = (精确搜索), prefix(前缀搜索), match(模糊搜索,只有name字段支持)

    c. bool: =

    d. double: =, <, >, <=, >=

  3. 复合类型支持的搜索:

    a. array: in (多条件的=)

    b. date: =, <, >, <=, >=

  4. 逻辑操作支持:not、and、or

  5. 支持括号,优先级为: “括号 > not > and > or”

query举例:

  1. 精确查询。

    1. // 查询文件名为 “汇报材料.ppt 的文件
    2. name = "汇报材料.ppt"
  2. 范围查询

    1. 查询2019114日前创建的文件
    2. created_at < "2019-01-14T00:00:00"
  3. 模糊匹配

    1. // 查询文件名包含 “汇报” 的文件
    2. name match "汇报"
  4. 逻辑组合查询

    1. // 查询2019114号创建的文件
    2. created_at > "2019-01-14T00:00:00" and created_at < "2019-01-15T00:00:00"
  5. 复杂逻辑查询

    1. // 查询文件size大于1024并且hiddenfalse并且file_extension不等于“mp4”的文件
    2. size > 1024 and hidden = false and not file_extension = 'mp4'
  6. 数组查询

    1. // 查询后缀名为jpgpng或者gif的文件
    2. file_extension in ["jpg", "png", "gif"]
  7. 前缀查询

    1. // 查询文件名为“项目1”开头的文件
    2. name prefix "项目1"

order_by规则:

  • ASC代表正序,DESC代表逆序
  • 语法为 字段名 + 空格 + ASC/DESC
  • 如果多个字段排序则需要用逗号隔开
  • 前面的规则优先级高

order_by举例:

  1. 单个规则正序

    1. // 按名称正序
    2. name ASC
  2. 单个规则逆序

    1. // 按创建时间逆序
    2. created_at DESC
  3. 多个排序规则

    1. // 先按创建时间逆序,如果创建时间相同,则按名称正序
    2. created_at DESC, name ASC

支持搜索和排序的字段

字段名 类型 可搜索 可排序 描述
parent_file_id STRING ✔️ 固定目录搜索,只搜索一级
name STRING ✔️ ✔️ 文件名(模糊分词),可模糊搜索
type STRING ✔️ ✔️ 文件类型file、folder
file_extension STRING ✔️ 文件后缀名
description STRING ✔️ 描述(single_word分词),可短语匹配
mime_type STRING ✔️ 文件mimeType搜索
starred BOOL ✔️ 是否收藏
created_at DATE ✔️ ✔️ 创建时间
updated_at DATE ✔️ ✔️ 修改时间
status STRING ✔️ 文件状态
trashed BOOL ✔️ 是否移入回收站
explicitly_trashed BOOL ✔️ 是否显式移入回收站
hidden BOOL ✔️ 是否隐藏文件
size LONG ✔️ ✔️ 文件大小
image_time DATE ✔️ ✔️ 照片拍摄时间
label STRING ✔️ 系统标签名称
category STRING ✔️ 文件类型,image、video、doc、audio、app、others
  • LONG: 长整型(int64)
  • BOOL: 布尔类型
  • DATE: 时间类型,用双引号或单引号括起来,与字符串类型一致。格式”2006-01-02T00:00:00”,默认零时区。
  • STRING: 字符串类型

返回

  • 同 list files 接口返回一样。