通过调用本接口,开发者可以查询租户内知识库列表。
请求地址
GEThttps://api.tbox.cn/api/datasets/queryDatasetsList
请求头
参数名 |
必填 |
类型 |
说明 |
示例 |
Authorization |
是 |
String |
用于验证客户端身份的访问令牌,你可以在百宝箱中获取,获取方式可参见:授权管理。 |
|
Content-Type |
text/plain |
解释请求正文的方式。 |
- |
请求参数
参数名 |
必填 |
类型 |
说明 |
示例 |
pageNum |
否 |
Integer |
分页页码,默认为 1,从第一页数据开始返回。 |
1 |
pageSize |
否 |
Integer |
分页大小,默认为 10,最大为 50。 |
10 |
请求示例
curl --location --request GET 'https://api.tbox.cn/api/datasets/queryDatasetsList?pageNum=1&pageSize=20' \ --header 'Authorization: {your_token}' \ --header 'Content-Type: text/plain'
返回参数
参数名 |
类型 |
说明 |
示例 |
errorCode |
String |
错误码,为 0 表示成功。 |
0 |
errorMsg |
String |
错误信息。 |
success |
data |
PageObject |
知识库列表信息,详细说明请参见:data 定义。 |
- |
traceId |
String |
本次请求的唯一标识,通常用于发生错误时的排查定位。 |
0b****4d9 |
其中,errorCode 与 errorMsg 的对照关系以及对应的解决方案,请参见下方错误码。
data 定义
参数名 |
类型 |
说明 |
currentPage |
Integer |
当前页 |
datasets |
List<Dataset> |
知识库文件对象列表,详细说明请参见:datasets 定义。 |
pageSize |
Integer |
分页大小 |
total |
Integer |
列表总数 |
datasets 定义
参数名 |
类型 |
说明 |
datasetId |
String |
知识库 ID |
description |
String |
知识库描述 |
name |
String |
知识库名称 |
storeSize |
Double |
知识库存储大小 |
返回示例
{ "data": { "currentPage": 1, "datasets": [ { "datasetId": "202508059lUk00458063", "description": "测试2", "name": "测试1", "storeSize": 0.0 }, { "datasetId": "20250804tpAo00457894", "description": "测试2", "name": "测试2", "storeSize": 7808.0 } ], "pageSize": 20, "total": 2 }, "errorCode": "0", "errorMsg": "success", "traceId": "0b446a1717543635033032613e386f" }
{ "errorCode": "P_1_00_005", "errorMsg": "pageSize不能大于50", "solution": "请确认参数值是否正确!", "traceId": "0be8c63017543648690345786e1a1c" }
错误码
公共错误码
errorCode |
errorMsg |
说明 |
S40000 |
系统异常 |
|
P_1_10_183 |
授权令牌无效 |
|
P_1_10_184 |
授权令牌已失效 |
|
P_1_10_185 |
未检测到授权令牌 |
|
P_1_13_682 |
非法访问,请联系平台 |
|
参数校验与业务错误码
errorCode |
errorMsg |
说明 |
P_1_00_005 |
pageSize不能大于50 |
|