AI 助理
文档备案控制台
官方文档
首页 大模型服务平台百炼 API参考（Agent） RAG API 同步任务 查询任务状态

查询任务状态

更新时间：
复制 MD 格式
产品详情
我的收藏

查询指定导入任务的执行状态和文档处理详情。index_id 和 job_id 必须同时传入。

前提

已获取 API Key 和业务空间 ID，并完成鉴权配置，详见API 总览与鉴权说明。

接口

GET /api/v1/indices/rag/index_job/status

查询指定导入任务的执行状态和文档处理详情。index_id 和 job_id 必须同时传入。

说明当知识库没有进行中的导入任务时，该接口可能返回 SystemError。建议在提交导入任务后调用。

请求参数

以下参数通过 query string 传递。

参数必填类型说明
index_id是string知识库 ID，对应创建知识库时返回的 pipelineId
job_id是string导入任务 ID。提交导入任务接口的返回字段 ingestionId，也可在文档列表的 ingestion_id 字段中找到。index_id 和 job_id 必须同时传入，仅传 index_id 会返回 SystemError
page_number否integer页码，从 1 开始，默认 1。任务含较多文档时可分页查询
page_size否integer每页返回的文档数量，默认 10

请求示例 

curl -G "$BASE_URL/api/v1/indices/rag/index_job/status" \
  -H "Authorization: Bearer $BAILIAN_API_KEY" \
  -d "index_id=your-kb-id" \
  -d "job_id=your-job-id"

其中 BASE_URL 为 https://{workspace_id}.cn-beijing.maas.aliyuncs.com（{workspace_id} 为业务空间 ID），BAILIAN_API_KEY 为阿里云百炼 API Key。

响应示例

查询成功返回 200。

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "id": "your-job-id",
    "ingestion_status": "COMPLETED",
    "ingestion_message": "COMPLETED",
    "total_count": 4,
    "rows": [
      {
        "code": "FINISH",
        "doc_id": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
        "doc_name": "sample_document",
        "doc_type": "pdf",
        "size": 191166,
        "status": "FINISH",
        "message": "索引构建成功",
        "ingestion_id": "your-job-id",
        "dataSync": false,
        "canDelete": true,
        "meta_extract_info": [],
        "gmt_modified": 1782209511000
      }
    ],
    "page_number": 1,
    "page_size": 10,
    "started_at": 1782209506000,
    "ended_at": 1782209512000,
    "created_at": 1782209506000,
    "updated_at": 1782209512000
  },
  "success": true,
  "message": "success",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "SUCCESS"
}

响应字段

字段类型说明
codestring响应码，成功时为 Success
status_codeintegerHTTP 状态码
request_idstring请求唯一标识，排查问题时请提供此 ID
successboolean请求是否成功
messagestring提示信息，成功时为 success
statusstring请求状态：SUCCESS 或 FAILED
dataobject任务状态与处理详情，子字段见下表

data 字段

字段类型说明
idstring导入任务 ID
ingestion_statusstring任务整体状态：PENDING（等待中）、RUNNING（进行中）、COMPLETED（已完成）
ingestion_messagestring任务状态描述，通常与 ingestion_status 一致
total_countinteger任务涉及的文档总数。任务进行中时可能为 0
rowsarray每个文档的处理详情。结构与查询文档列表接口的 rows 一致。元素字段见下表
page_numberinteger当前页码
page_sizeinteger每页数量
started_atinteger任务开始时间（毫秒级 Unix 时间戳）
ended_atinteger任务结束时间（毫秒级 Unix 时间戳）。进行中时为 null
created_atinteger任务创建时间（毫秒级 Unix 时间戳）
updated_atinteger任务最后更新时间（毫秒级 Unix 时间戳）

rows 元素字段

字段类型说明
doc_idstring文档 ID
doc_namestring文档名称
doc_typestring文档类型
codestring细粒度处理状态码，如 FINISH、PARSE_FAILED
statusstring粗粒度处理状态
messagestring处理状态描述
sizeinteger文件大小（字节）
ingestion_idstring所属导入任务 ID
connectorIdstring关联的连接器 ID，未使用连接器时为空字符串
categoryIdstring文件所属类目 ID
categoryNamestring文件所属类目名称
tagsstring文件标签，多个标签以逗号分隔
dataSyncboolean该文件是否参与数据同步
canDeleteboolean该文件是否可删除
source_idstring文件来源标识
gmt_modifiedinteger最后修改时间，Unix 毫秒时间戳
meta_extract_infoarray元数据抽取结果

错误码

HTTP 状态码错误码（code）说明
400Index.InvalidParameter请求参数无效：Required parameter missing or invalid.
401InvalidApiKeyAPI Key 无效或缺失：Invalid API-key provided.
上一篇：提交导入任务下一篇：数据导入