搜索文档库
适用版本>=v7.0.2505b.20250529
接口说明：搜索文档库
标签：文档库
请求说明
| 字段 | 值 |
|---|---|
请求地址 | 配置域名+/openapi+/v7/doclib/search |
HTTP 方法 | GET |
接口描述 | 搜索文档库 |
签名方式 | KSO-1（配置域名+/openapi不参与签名） |
限频策略 | 无 |
权限要求 | 查询和管理文档库(应用授权) kso.doclib.readwrite查询文档库(应用授权) kso.doclib.read查询和管理文档库(用户授权) kso.doclib.readwrite查询文档库(用户授权) kso.doclib.read |
请求头 (Headers)
| 属性名 | 类型 | 是否必填 | 描述 | 可选值 |
|---|---|---|---|---|
X-Kso-Id-Type | string | 否 | 类型 * internal - 内部 * external - 外部 | internal, external |
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)
| 属性名 | 类型 | 是否必填 | 描述 | 可选值 |
|---|---|---|---|---|
page_size | int | 是 | 分页大小，page_size和page_token值相加最大值为10000（即最多查到前10000条数据） | - |
company_id | string | 是 | 企业ID,<= 1024 characters | - |
keyword | string | 是 | 搜索关键字,<= 1024 characters | - |
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回next_page_token作为新的page_token，下次遍历可采用该page_token获取查询结果 | - |
group_type | string | 否 | 用户组类型,可选值: whole：全员用户组；normal：普通用户组；dept：部门用户组 | - |
group_source | array | 否 | 用户组来源 | - |
响应体(Response)
HTTP状态码: 200
响应体格式: application/json
没有可用的数据
响应体示例
json
{
"data": {
"items": [
{
"highlights": {
"example_key": [
"string"
]
},
"drive": {
"allotee_id": "string",
"allotee_type": "string",
"bucket": "string",
"company_id": "string",
"created_by": {
"avatar": "string",
"company_id": "string",
"id": "string",
"name": "string",
"type": "string"
},
"ctime": 0,
"description": "string",
"ext_attrs": [
{
"name": "string",
"value": "string"
}
],
"id": "string",
"mtime": 0,
"name": "string",
"quota": {
"deleted": 0,
"remaining": 0,
"total": 0,
"used": 0
},
"source": "string",
"status": "string"
},
"group": {
"avatar": "string",
"company_id": "string",
"creator_id": "string",
"ctime": 0,
"dept_id": "string",
"description": "string",
"id": "string",
"member_total": 0,
"mtime": 0,
"name": "string",
"owner_id": "string",
"source": "string",
"status": "string",
"type": "string"
},
"pinned": true,
"user_role": "string"
}
],
"next_page_token": "string"
},
"code": 0,
"msg": "string"
}