AgentKit
AgentKit
文档指南
请输入
- 文档首页
AgentKitAgentKit开发者指南API参考KnowledgeListKnowledgeBases - 批量查询知识库详情
复制全文
下载 pdfListKnowledgeBases - 批量查询知识库详情
文档反馈
问问助手通过自定义筛选条件批量查询知识库详情。
请求参数
Action string 必选 示例值：ListKnowledgeBases
要执行的操作，取值：ListKnowledgeBases。
Version string 必选 示例值：2025-10-30
API的版本，取值：2025-10-30。
CreateTimeAfter string 可选 示例值：2025-09-17T10:00:00+8:00
筛选该时间点后创建的知识库。（RFC3339格式）
CreateTimeBefore string 可选 示例值：2025-09-17T10:00:00+8:00
筛选该时间点前创建的知识库。（RFC3339格式）
Filters.N.Name string[] 可选 示例值：name
精确过滤的字段名。
- 参数 - N：表示过滤条件的序号，取值范围：1～10。
- 多个字段名之间用&分隔，为“或”的关系。
- 取值：
- knowledge_id：知识库ID。
- name：知识库名称。
- status：知识库状态。
- provider_type：导入的知识库平台类型。
说明
当Filters.N.Name和Filters.N.NameContains同时传入时，仅Filters.N.Name生效。
Filters.N.NameContains string[] 可选 示例值：name
模糊过滤的字段名。
- 参数 - N：表示过滤条件的序号，取值范围：1～10。
- 多个字段名之间用&分隔，为“或”的关系。
- 取值：
- knowledge_id：知识库ID。
- name：知识库名称。
- status：知识库状态。
- provider_type：导入的知识库平台类型。
说明
当Filters.N.Name和Filters.N.NameContains同时传入时，仅Filters.N.Name生效。
Filters.N.Values.N string[] 可选 示例值：my_collection
过滤字段的值。
- 参数 - N：表示过滤条件的序号，取值范围：1～10。
- 多个字段名之间用&分隔。
当过滤字段为provider_type时，取值：
- VIKINGDB_KNOWLEDGE：Viking知识库。
当过滤字段为status时，取值：
- Importing：导入中。
- ImportFailed：导入失败。
- Ready：成功。
- Deleting：删除中。
- DeleteFailed：删除失败。
- Deleted：资源失效。
- Error：错误。
MaxResults integer 可选 示例值：10
分页查询时设置的每页行数。
- 最小值：1。
- 最大值：100。
- 默认值：10。
NextToken string 可选 示例值：unique-token
分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。
UpdateTimeAfter string 可选 示例值：2025-09-17T10:00:00+8:00
筛选该时间点后更新的知识库。（RFC3339格式）
UpdateTimeBefore string 可选 示例值：2025-09-17T10:00:00+8:00
筛选该时间点前更新的知识库。（RFC3339格式）
ProjectName string 可选 示例值：default
所属项目名称。
返回参数
KnowledgeBases object[] 示例值：--
符合要求的知识库信息。
AssociatedRuntimes object[] 示例值：--
关联的运行时信息。
Id string 示例值：r-ye9tu7****
运行时ID。
Name string 示例值：runtime-01
运行时名称。
NetworkConfiguration object 示例值：--
Runtime的访问信息，包括公网和VPC。
EnablePrivateNetwork boolean 示例值：false
是否开启运行时的私网访问能力，取值：
- true：开启。
- false：不开启。
EnablePublicNetwork boolean 示例值：true
是否开启运行时的公网访问能力，取值：
- true：开启。
- false：不开启。
VpcConfiguration object 示例值：--
VPC私网配置。
SecurityGroupIds string[] 示例值：["sg-w08tvkc3e****"]
安全组ID列表。
SubnetIds string[] 示例值：["subnet-1234567890"]
子网ID列表。
VpcId string 示例值：vpc-257gqcdfvx6n****
VPC ID。
ProjectName string 示例值：default
运行时所属项目名称。
Region string 示例值：cn-beijing
知识库所属区域。
CreateTime string 示例值：2025-09-17T10:00:00+8:00
知识库创建时间。
Description string 示例值：knowledge-test
知识库描述。
KnowledgeId string 示例值：kb-4yds45****
知识库ID。
LastUpdateTime string 示例值：2025-09-17T10:00:00+8:00
知识库更新时间。
Name string 示例值：my_collection
知识库名称。
ProviderKnowledgeId string 示例值：kb-ye7s2g****
已导入的知识库ID。
ProviderType string 示例值：VIKINGDB_KNOWLEDGE
知识库平台类型。取值：
- VIKINGDB_KNOWLEDGE：Viking知识库。
Status string 示例值：Ready
知识库状态，取值：
- Importing：导入中。
- ImportFailed：导入失败。
- Ready：成功。
- Deleting：删除中。
- DeleteFailed：删除失败。
- Deleted：资源失效。
- Error：错误。
NextToken string 示例值：bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******
本次调用返回的查询凭证值，返回为空表示该页为末页。
请求示例
POST https://agentkit.cn-beijing.volcengineapi.com?Action=ListKnowledgeBases&Version=2025-10-30 HTTP/1.1
Content-Type: application/json
{
"PageNumber": 1
}
返回示例
{
"ResponseMetadata": {
"RequestId": "202106111445100102252431000052****",
"Action": "ListKnowledgeBases",
"Version": "2025-10-10",
"Service": "agentkit",
"Region": "cn-beijing"
},
"Result": {
"ListKnowledgeBasesResponseNextToken":{
"KnowledgeBases": [
{
"KnowledgeId":"kb-1761138694808283000-1" ,
"Name":"my_travel_knowledge" ,
"ProviderKnowledgeId":"kb-travel-001" ,
"ProviderType":"VIKINGDB_KNOWLEDGE" ,
"Description":"knowledge-test" ,
"Status":"Ready" ,
"CreateTime":"2025-09-16T10:00:00Z" ,
"LastUpdateTime":"2025-09-16T10:05:00Z"
}
],
"NextToken":"next-token"
}
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | LimitExceeded.MaximumMaxResults | The number of specified MaxResults exceeds the maximum limit. | 指定的MaxResults超过最大限制。 |
400 | LimitExceeded.MaximumPageSize | The number of specified PageSize exceeds the maximum limit. | 指定的PageSize超过最大限制。 |
最近更新时间：2025.12.16 10:09:01
这个页面对您有帮助吗？
有用
有用
无用
无用