获取知识库列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| pailangstudio:ListKnowledgeBases | list | *全部资源 * |
| 无 |
请求语法
GET /api/v1/langstudio/knowledgebases HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 否 | 工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。 | 478*** |
| Name | string | 否 | 知识库名称。 | myName |
| KnowledgeBaseId | string | 否 | 知识库 ID。 | d-nacr******sxd2 |
| NextToken | string | 否 | 用来标记当前开始读取的位置，置空表示从头开始。 | 10 |
| MaxResults | integer | 否 | 使用 NextToken 方式查询时，每次最多返回的结果数。 | 20 |
| SortBy | string | 否 | 排序字段。目前只支持 GmtCreateTime。 | GmtCreateTime |
| Order | string | 否 | 排序方式。
| DESC |
| PageNumber | integer | 否 | 当前页数。 取值范围：大于 0。 默认值：1。如果同时传入 MaxResults，则使用 NextToken 查询方式，忽略此字段值。 | 1 |
| PageSize | integer | 否 | 每页查询的数量。如果同时传入 MaxResults，则以 MaxResults 数量为准。 | 10 |
| Creator | string | 否 | 创建者用户 ID。 | 2680******4103 |
| KnowledgeBaseType | string | 否 | 知识库类型。
| TEXT |
返回参数
示例
正常返回示例
JSON格式
{
"KnowledgeBases": [
{
"WorkspaceId": "478***",
"Accessibility": "PRIVATE",
"GmtCreateTime": "2024-12-15T14:46:23Z",
"GmtModifiedTime": "2025-12-18T19:32:58Z",
"Name": "myName",
"KnowledgeBaseId": "d-nacr******sxd2",
"Description": "This is a description of the knowledge base.",
"KnowledgeBaseType": "TEXT",
"DatasetId": "d-lvb6****865w",
"DataSources": [
{
"Uri": "oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/source/"
}
],
"OutputDir": "oss://test-bucket.oss-cn-hangzhou-internal.aliyuncs.com/langstudio/output/",
"ChunkConfig": {
"ChunkSize": 1024,
"ChunkOverlap": 200,
"ChunkDuration": 20,
"ChunkStrategy": "Default"
},
"EmbeddingConfig": {
"EmbeddingType": "DashScope",
"ConnectionName": "myEmbeddingConn",
"ConnectionId": "conn-r3o7******38bh",
"Model": "text-embedding-v4"
},
"VectorDBConfig": {
"VectorDBType": "Milvus",
"ConnectionName": "myConnName",
"ConnectionId": "conn-v2wq****z7rg",
"CollectionName": "my_collection"
},
"UserVpc": {
"VpcId": "vpc-y7d8****io93"
},
"Creator": "1247****1467",
"RuntimeId": "rtime-78****d6",
"ScheduleConfig": {
"InstanceMode": "T+1",
"Recurrence": "Normal",
"RerunMode": "***",
"FailureRerunConfig": {
"RerunTimes": 3,
"RerunInterval": 1800
},
"Timeout": 30,
"TriggerConfig": {
"Cron": "0 0/10 * * * ?",
"StartTime": "2025-04-14T02:22:01Z",
"EndTime": "2025-04-14T02:30:00Z"
},
"ResourceGroupConfig": {
"ResourceGroup": {},
"Id": 113
},
"EcsSpecs": [
{
"Type": "Worker",
"InstanceType": "ecs.c6.large",
"PodCount": 1,
"CPU": 4,
"GPU": 1,
"Memory": 16,
"SharedMemory": 16,
"GPUType": "V100",
"Driver": "550.127.08"
}
],
"UserVpc": {
"VpcId": "vpc-wz90****5v23",
"VSwitchId": "vsw-wz9r****ng10",
"SecurityGroupId": "sg-wz9i****1129"
},
"ResourceId": "quota89**76",
"Status": "Success",
"GmtCreateTime": "2025-04-29T02:07:14Z",
"GmtModifiedTime": "2025-04-29T02:40:36Z",
"ScheduleWorkflowId": "6237****9023",
"ScheduleCycleTaskId": "11**67"
},
"MetaDataConfig": {
"CustomMetaData": [
{
"Key": "column1",
"ValueType": "String",
"ReferenceCount": 3,
"ValueCount": 8
}
]
},
"AutoUpdateConfig": {
"Status": "Enable",
"ResourceId": "quota87**45",
"MaxRunningTimeInSeconds": 86400,
"EmbeddingConfig": {
"BatchSize": 8,
"Concurrency": 1
},
"UserVpc": {
"VpcId": "vpc-m5ec******44cn",
"VSwitchId": "vsw-hp32******z9qo",
"SecurityGroupId": "sg-bp1f******iy9h"
},
"EcsSpecs": [
{
"Type": "Worker",
"InstanceType": "ecs.c6.large",
"PodCount": 1,
"GPUType": "V100",
"CPU": 4,
"GPU": 1,
"Memory": 16,
"SharedMemory": 16,
"Driver": "550.127.08"
}
]
},
"VersionName": "v1",
"IndexColumnConfig": {
"EmbeddingColumns": [
{
"Key": "column1"
}
],
"ContentColumns": [
{
"Key": "column1"
}
],
"ColumnDefinitions": [
{
"Key": "column1"
}
]
},
"IndexManifest": {}
}
],
"MaxResults": 20,
"NextToken": 20,
"TotalCount": 51,
"RequestId": "35686626-8D83-5ADE-B400-08A6613A6057"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-01-08 | OpenAPI 返回结构发生变更 | 查看变更详情 |