获取知识库任务列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| pailangstudio:ListKnowledgeBaseJobs | list | *全部资源 * |
| 无 |
请求语法
GET /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 否 | 知识库所在工作空间 ID。 | 478** |
| KnowledgeBaseId | string | 否 | 知识库 ID。 | d-ksicx823d |
| KnowledgeBaseJobId | string | 否 | 知识库任务 ID。 | kbjob-9m******54 |
| Status | string | 否 | 知识库任务状态。
| Running |
| JobAction | string | 否 | 任务操作类型。
| SyncIndex |
| NextToken | string | 否 | 用来标记当前开始读取的位置，置空表示从头开始。 | 10 |
| MaxResults | integer | 否 | 使用 NextToken 方式查询时，每次最多返回的结果数。 | 10 |
| SortBy | string | 否 | 排序字段。目前只支持 GmtCreateTime。 | GmtCreateTime |
| Order | string | 否 | 排序方式。
| DESC |
| PageNumber | integer | 否 | 当前页数。 取值范围：大于 0。 默认值：1。如果同时传入 MaxResults，则使用 NextToken 查询方式，忽略此字段值。 | 1 |
| PageSize | integer | 否 | 每页查询的数量。如果同时传入 MaxResults，则以 MaxResults 数量为准。 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"KnowledgeBaseJobs": [
{
"WorkspaceId": "478**",
"Accessibility": "PRIVATE",
"Creator": "2003******4844",
"GmtCreateTime": "2024-05-13T01:43:15Z",
"GmtModifiedTime": "2024-05-13T03:05:22Z",
"KnowledgeBaseId": "d-ksicx823d",
"KnowledgeBaseJobId": "kbjob-9m******54",
"JobAction": "SyncIndex",
"Description": "This is a description of the knowledge base job.",
"Status": "Running",
"ResourceId": "quota89**76",
"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-wz91****e10e"
},
"MaxRunningTimeInSeconds": 86400,
"GmtFinishTime": "2024-05-13T04:03:27Z",
"ErrorMessage": "Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z",
"PipelineRunInfo": {
"PipelineRunId": "flow-fi8z******g4gy"
},
"KnowledgeBaseJobResult": {
"TotalFileCount": 1,
"AddChunkCount": 10,
"DeleteChunkCount": 2,
"FileMetas": [
{
"FileMetaId": "ks3fje****8cedew",
"FileName": "abc.pdf",
"FileUri": "oss://mybucket/path/abc.pdf",
"Action": "Add"
}
]
},
"EmbeddingConfig": {
"BatchSize": 8,
"Concurrency": 1
}
}
],
"MaxResults": 20,
"NextToken": 20,
"TotalCount": 32,
"RequestId": "963BD7F9-0C02-5594-9550-BCC6DD43E3C0"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-01-08 | OpenAPI 返回结构发生变更 | 查看变更详情 |