调用GetKnowledgeBaseJob获取知识库任务详情-人工智能平台 PAI-阿里云

获取知识库任务。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
pailangstudio:GetKnowledgeBaseJob	get	全部资源 ``	无	无

请求语法

GET /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs/{KnowledgeBaseJobId} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	string	是	知识库所在工作空间 ID。	478***
KnowledgeBaseId	string	是	知识库 ID。	d-nacr******sxd2
KnowledgeBaseJobId	string	是	知识库任务 ID。	kbjob-9m******54

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	C25324E3-18E6-50D8-9026-16D74AAEEB26
WorkspaceId	string	知识库所在工作空间 ID。	478***
Accessibility	string	工作空间可见性，可能值为： PRIVATE：在此工作空间中，仅对您和管理员可见。 PUBLIC：在此工作空间中，对所有人可见。	PUBLIC
Creator	string	创建者用户 ID。	2003******4844
GmtCreateTime	string	任务创建时间（UTC）。	2025-09-24T07:33:53Z
GmtModifiedTime	string	任务更新时间（UTC）。	2025-09-24T08:58:35Z
KnowledgeBaseId	string	知识库 ID。	d-nacr******sxd2
KnowledgeBaseJobId	string	知识库任务 ID。	kbjob-9m******54
JobAction	string	任务操作类型。 SyncIndex：更新知识库索引	UpdateScheduleConfig
Description	string	知识库任务描述。	This is a description of the knowledge base job.
Status	string	知识库任务状态。 Running: 运行中。 Success: 运行成功。 Failed: 运行失败。	discovering
ResourceId	string	资源组 ID。为空或 public-cluster 表示公共资源。	quota89**76
EcsSpecs	array<object>	运行资源配置列表。
EcsSpecElem	object	运行资源配置列表。
Type	string	节点类型。可能的值为 Head 和 Worker。	Worker
InstanceType	string	机型名称。	ecs.c6.large
PodCount	integer	副本数量。	1
CPU	integer	CPU 核数。	4
GPU	integer	GPU 卡数。	1
Memory	integer	内存大小，单位 GB。	16
SharedMemory	integer	共享内存容量，单位 GB。	16
GPUType	string	GPU 类型。	V100
Driver	string	驱动版本。	550.127.08
UserVpc	object	任务运行 VPC 信息。
VpcId	string	VPC ID。	vpc-wz90****5v23
VSwitchId	string	交换机 ID。	vsw-wz9r****ng10
SecurityGroupId	string	安全组 ID。	sg-wz91****e10e
MaxRunningTimeInSeconds	integer	任务最大运行时间，单位秒。	86400
GmtFinishTime	string	任务结束时间（UTC）。	2025-02-08T15:45:12Z
ErrorMessage	string	任务出错信息。	Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z
PipelineRunInfo	object	工作流运行信息。
PipelineRunId	string	PaiFlow 工作流运行 ID	flow-fi8z******g4gy
KnowledgeBaseJobResult	object	任务结果。
TotalFileCount	integer	总处理文件数	1
AddChunkCount	integer	增加 Chunk 数量	10
DeleteChunkCount	integer	删除 Chunk 数量	2
EmbeddingConfig	object	索引配置。
BatchSize	integer	索引分批大小。文档和结构化数据类型知识库有效。	10
Concurrency	integer	索引并发数。图片和视频类型知识库有效。	2

示例

正常返回示例

JSON格式

{
  "RequestId": "C25324E3-18E6-50D8-9026-16D74AAEEB26",
  "WorkspaceId": "478***",
  "Accessibility": "PUBLIC",
  "Creator": "2003******4844",
  "GmtCreateTime": "2025-09-24T07:33:53Z",
  "GmtModifiedTime": "2025-09-24T08:58:35Z",
  "KnowledgeBaseId": "d-nacr******sxd2",
  "KnowledgeBaseJobId": "kbjob-9m******54",
  "JobAction": "UpdateScheduleConfig",
  "Description": "This is a description of the knowledge base job.",
  "Status": "discovering",
  "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": "2025-02-08T15:45:12Z",
  "ErrorMessage": "Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z",
  "PipelineRunInfo": {
    "PipelineRunId": "flow-fi8z******g4gy"
  },
  "KnowledgeBaseJobResult": {
    "TotalFileCount": 1,
    "AddChunkCount": 10,
    "DeleteChunkCount": 2
  },
  "EmbeddingConfig": {
    "BatchSize": 10,
    "Concurrency": 2
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2026-01-08	OpenAPI 返回结构发生变更	查看变更详情