GetIndexJobStatus_大模型服务平台百炼_API文档-阿里云OpenAPI开发者门户

接口说明

RAM 用户（子账号）需要首先获取百炼的数据权限（AliyunBailianDataFullAccess或AliyunBailianDataReadOnlyAccess均可，已包括 sfm:GetIndexJobStatus 权限点），然后才能调用本接口，详见为 RAM 用户授予数据权限。阿里云账号（主账号）可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。
您需要有一个正在执行中的知识库作业任务（创建知识库任务可以调用 SubmitIndexJob 接口，创建知识库追加任务可以调用 SubmitIndexAddDocumentsJob 接口），并且获得相应的JobId。
本接口调用间隔建议在 5 秒以上。
本接口具有幂等性。

当前云产品API请求速率暂未透出。

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

sfm:GetIndexJobStatus	Get	全部资源 *	无	无

GET /{WorkspaceId}/index/job/status HTTP/1.1

字段名称	字段详情
WorkspaceIdstring	业务空间 ID，请确保您要操作的知识库在此业务空间中。获取方式请参见如何使用业务空间。示例值:llm-3z7uw7fwz0vexxxx

字段名称	字段详情
JobIdstring	知识库作业任务 ID，即 SubmitIndexJob 接口或 SubmitIndexAddDocumentsJob 接口返回的`Data.Id`。示例值:20230718xxxx-146c93bf
IndexIdstring	知识库 ID，即 CreateIndex 接口返回的`Data.Id`。示例值:79c0alxxxx参考取值来源: SubmitIndexJob
PageNumberinteger<int32>	SubmitIndexJob 接口和 SubmitIndexAddDocumentsJob 接口均支持批量导入文档。本接口返回的字段包括知识库作业任务的总状态`Status`及各文档导入的状态`Document.Status`。若文档较多，可通过`PageNumber`参数进行分页查询。起始值为 1，默认值为 1。示例值:1
pageSizeinteger<int32>	指定分页查询时每页展示的文档导入任务数量。最大值不限。默认值为 10。示例值:10

字段名称	字段详情
Codestring	错误状态码。示例值:Index.Forbidden
Dataobject	接口业务数据字段。
Messagestring	错误信息。示例值:User not authorized to operate on the specified resource.
RequestIdstring	请求 ID。示例值:17204B98-xxxx-4F9A-8464-2446A84821CA
Statusstring	接口返回的状态码。示例值:200
Successboolean	接口调用是否成功，可能值为：展开详情示例值:true

	变更时间	变更内容概要	操作
	2025-03-25	变更返回参数
	2024-09-05	新增请求参数PageNumber 新增请求参数pageSize