Skip to main content

Query Task Status

Query the execution status of a knowledge base import task

GET
/api/v1/indices/rag/index_job/status
cURL
curl -G "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index_job/status" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -d "index_id=your_index_id" \
  -d "job_id=your_job_id"
{
  "code": "Success",
  "status_code": 200,
  "data": {
    "id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "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": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "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"
}
This API may return a SystemError when there is no ongoing import task in the knowledge base. It is recommended to call this endpoint after submitting an import task.

Authorizations

​
string
header
required

DashScope API Key，在控制台 API Key 页面 获取。

Query Parameters

​
string
required

知识库 ID，对应创建知识库时返回的 pipelineId。

Required range:length >= 1
​
string
required

导入任务 ID。提交导入任务接口的返回字段 ingestionId，也可在文档列表的 ingestion_id 字段中找到。index_id 和 job_id 必须同时传入，仅传 index_id 会返回 SystemError。

Required range:length >= 1
​
integer
default1

页码，从 1 开始，默认 1。任务含较多文档时可分页查询。

Required range:x >= 1
​
integer
default10

每页返回的文档数量，默认 10。

Required range:x >= 1

Response

200-application/json
​
string

响应码，成功时为 Success。

​
integer

HTTP 状态码。

​
string

请求唯一标识，排查问题时请提供此 ID。

​
object
​
boolean

请求是否成功。

​
string

提示信息，成功时为 success。

​
string

请求状态：SUCCESS 或 FAILED。