RESTful

Get Import Job Progress

This operation gets the progress of the specified bulk-import job.

POST

/v2/vectordb/jobs/import/get_progress

Base URL

The base URL for this API is in the following format:

http://localhost:19530

export CLUSTER_ENDPOINT="http://localhost:19530"

Parameters

Request-Timeoutintegerheader

The timeout duration for this operation. Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.

Example Value: 0

Authorizationstringheaderrequired

The authentication token should be a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}

Request Bodyapplication/json

dbNamestring

The name of the target database of this operation.

jobIdstringrequired

The ID of the bulk-import job of your interest. The Create Import Jobs operation usually returns a job ID. You can also call List Import Jobs to get the IDs of all bulk-import jobs related to the specific cluster.

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/vectordb/jobs/import/get_progress" \
--header "Request-Timeout: 0" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "jobId": "job-xxxxxxxxxxxxxxxx"
}'

Responses200 - application/json

SUCCESS

codeinteger

Response code.

Example Value: 0

dataobject

Response payload which contains the progress of the specified bulk-import job in detail.

collectionNamestring

The name of the target collection of this bulk-import job.

completeTimestring

The timestamp indicating when the bulk-import job is complete.

detailsarray

Statistics on data import oriented to data files.

[]detailsobject

Statistics on data import from a file.

completeTimestring

The timestamp at which the file is processed.

fileNamestring

The name of a data file.

fileSizestring

The size of the data file.

progressstring

The progress in percentage.

statestring

The processing state of the data file.

Possible Values:

reasonstring

The reason for the failure to bulk import data. This field stays empty if this job succeeds.

importedRowsstring

The number of rows imported from this file.

totalRowsstring

The number of rows in the specified collection upon the import from this file is complete.

fileSizeinteger

The uploaded file size in bytes.

jobIdinteger

The ID of this bulk-import job.

progressinteger

The progress in percentage of the current bulk-import job.

statestring

The state of this bulk-import job.

Possible Values:

reasonstring

The reason for the failure to bulk import data. The field value stays empty if this job succeeds.

importedRowsinteger

The number of rows inserted into the specified collection upon this import.

totalRowsinteger

The number of rows in the specified collection.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": {
        "jobId": "448761313698322011",
        "collectionName": "medium_articles",
        "fileName": "medium_articles_2020_dpr.json",
        "fileSize": 3279917,
        "state": "Completed",
        "progress": 100,
        "completeTime": "2024-04-01T06:17:55Z",
        "reason": "",
        "totalRows": 100000,
        "details": [
            {
                "fileName": "medium_articles_2020_dpr.json",
                "fileSize": 3279917,
                "state": "Completed",
                "progress": 100,
                "completeTime": "2024-04-01T06:17:53Z",
                "reason": ""
            }
        ]
    }
}