全文检索
适用版本>=v7.0.2603.20260326
标签:search
请求说明
| 字段 | 值 |
|---|---|
请求地址 | 配置域名+/openapi+/v7/aiopen/files/search |
HTTP 方法 | GET |
接口描述 | 全文检索 |
签名方式 | KSO-1(配置域名+/openapi不参与签名) |
限频策略 | 无 |
权限要求 | 0卡版空间文件管理开放能力(应用授权) kso.aiopen_drive_file.readwrite |
请求头 (Headers)
| 属性名 | 类型 | 是否必填 | 描述 | 可选值 |
|---|---|---|---|---|
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT | - |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 | - |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} | - |
查询参数 (Query)
| 属性名 | 类型 | 是否必填 | 描述 | 可选值 |
|---|---|---|---|---|
drive_ids | array | 是 | 空间id | - |
keyword | string | 是 | 搜索关键字 | - |
creator_id | string | 否 | 创建者id | - |
type | object | 否 | 搜索类型,可选值: name-按文件名搜索,content-正文全文检索 | - |
file_exts | array | 否 | 文件后缀,搜索超过40种后缀时,筛选失效,默认搜索全格式。 | - |
time_type | object | 否 | 时间类型,可选值: ctime-按创建时间限制,mtime-按修改间限制 | - |
start_time | integer | 否 | 最小时间,时间戳,单位为秒 | - |
end_time | integer | 否 | 最大时间,时间戳,单位为秒 | - |
page_size | integer | 否 | 分页大小,page_size和page_token值相加最大值为10000(即最多查到前10000条数据) | - |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果 | - |
order | object | 否 | 排序方式 | - |
order_type | object | 否 | 排序字段 | - |
响应体(Response)
HTTP状态码: 200
响应体格式: application/json
没有可用的数据
响应体示例
json
{
"data": {
"items": [
{
"file": {
"creator_id": "string",
"ctime": 0,
"drive_id": "string",
"file_content": "string",
"file_id": "string",
"mtime": 0,
"name": "string",
"size": 0
},
"highlights": {
"example_key": [
"string"
]
}
}
],
"next_page_token": "string"
},
"code": 0,
"msg": "string"
}