获取知识库下文档列表
更新时间 2026-01-13 00:41:10
最近更新时间: 2026-01-13 00:41:10
本文介绍获取知识库下文档列表内容。
接口描述
获取知识库下已上传的文档列表
请求方法
GET
接口要求
无
URI
/openapi/v1/documents/list
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| Content-Type | 是 | String | json格式 | application/json | |
| tenantId | 是 | String | 租户ID | 562b89493b1a40e1b97ea05e50dd8170 | |
| ctyun-eop-request-id | 是 | String | 用户请求 id，由用户构造，用户可以通过 uuid 等方法自行生成唯一字符串，用于日志请求追踪 | 33dfa732-b27b-464f-b15a-21ed6845afd5 | |
| eop-date | 是 | String | 请求时间，由用户构造，形如 yyyymmddTHHMMSSZ。 | 20211221T163014Z | |
| host | 是 | String | 终端节点域名，固定字段 | kqa-global.ctapi.ctyun.cn | |
| Eop-Authorization | 是 | String | 由天翼云官网 accessKey 和 securityKey 经签名后生成，参与签名生成的字段包括天翼云官网 accessKey 、securityKey、平台应用的appkey（非必须），用户请求id（非必须），请求时间，终端节点域名（非必须）以及请求体内容。 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| infoBaseId | 是 | Int | 知识库ID | - | |
pageEnabled | 否 | Boolean | 是否开启列表分页，默认false |
|
|
| 否 | Int | 页码（分页开启后生效） |
|
|
pageSize | 否 | Int | 页大小（分页开启后生效） |
|
|
orderAsc | 否 | Boolean | 是否按照创建时间正序排序（默认正序，分页开启后生效） |
|
|
请求代码示例
Curl -X GET "https://kqa-global.ctapi.ctyun.cn/openapi/v1/documents/list?infoBaseId=100"
-H "Content-Type: application/json"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "tenantId:XXX"
-H "Eop-Authorization:XXX"
-H "eop-date:20211109T104641Z"
-H "host:kqa-global.ctapi.ctyun.cn"返回值说明
1.请求成功返回响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
| statusCode | String | 返回状态，返回200表示成功 | 200 | |
| message | String | 返回Success | Success | |
| returnObj | Array | 接口返回结果 | returnObj表 |
returnObj表
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
| id | Int | 文件ID | 10 | |
| name | String | 文件名 | 测试.pdf | |
| fileSize | Int | 文件大小，字节 | 12231 | |
| status | String | 文件状态 UPLOADING, UPLOADED, ERROR, CHECKING, PARSING, PARSED | UPLOADED | |
| infoBaseId | Int | 知识库ID | 100 | |
| createTime | String | 创建时间 | 2023-05-08T15:14:00Z | |
| updateTime | String | 更新时间 | 2023-05-08T15:14:00Z |
分页返回参数
returnObj表
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
| total | Int | 总记录数 | 10 | |
pageNum | Int | 第几页 | 1 | |
pageSize | Int | 每页几条 | 10 | |
totalPages | Int | 总页数 |
| |
hasNext | Boolean | 是否有下一页 |
| |
hasPrevious | Boolean | 是否有上一页 |
|
|
2.请求失败返回响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
| statusCode | String | 错误码，放置API对应的错误码 | 40001 | |
| message | String | 失败信息 | 缺少鉴权信息 | |
| error | String | 返回对应的错误码 | KQA_40001 |
返回值示例
1.请求成功返回值示例
{
"statusCode": "200",
"error": null,
"message": "Success",
"returnObj": [
{
"id": 1012,
"name": "测试.pdf",
"fileSize": 3353421,
"status": "UPLOADED",
"infoBaseId": 280,
"createTime": "2025-09-18T17:56:31+08:00",
"updateTime": "2025-09-18T17:59:00+08:00"
}
]
}2.开启分页，请求成功返回值示例
{
"statusCode": 200,
"error": null,
"message": "Success",
"returnObj": {
"items": [
{
"id": 1105,
"name": "0523测试文档.txt",
"fileSize": 345,
"status": "UPLOADED",
"infoBaseId": 302,
"createTime": "2025-11-20T11:31:26+08:00",
"updateTime": "2025-11-20T11:32:00+08:00"
},
{
"id": 1107,
"name": "OpenAPI透传底层参数说明.docx",
"fileSize": 12172,
"status": "UPLOADED",
"infoBaseId": 302,
"createTime": "2025-11-21T10:27:09+08:00",
"updateTime": "2025-11-21T10:29:00+08:00"
},
{
"id": 1109,
"name": "息壤-应用托管产品介绍V1.pptx",
"fileSize": 2422265,
"status": "UPLOADED",
"infoBaseId": 302,
"createTime": "2025-11-21T10:27:09+08:00",
"updateTime": "2025-11-21T10:29:00+08:00"
},
{
"id": 1108,
"name": "知识库API.docx",
"fileSize": 141560,
"status": "UPLOADED",
"infoBaseId": 302,
"createTime": "2025-11-21T10:27:09+08:00",
"updateTime": "2025-11-21T10:31:45+08:00"
}
],
"total": 4,
"pageNum": 1,
"pageSize": 4,
"totalPages": 1,
"hasNext": false,
"hasPrevious": false
}
}3.请求失败返回值示例
{
"statusCode": "40004",
"error": "KQA_40004",
"message": "接口执行异常"
}状态码
| http状态码 | 描述 |
| 200 | 表示请求成功 |
错误码说明
| 错误码 | 错误信息 | 错误描述 |
| 40005 | 知识库不存在 | 未查询到可用知识库 |
