Skip to main content

Get Import Job Progress

Retrieves the progress of a specified import job.

POST
/v2/vectordb/jobs/import/getProgress
Base URL

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

https://api.cloud.zilliz.com

export BASE_URL="https://api.cloud.zilliz.com"
Parameters
Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}
Acceptstringheader

Use application/json.

Example Value: application/json
Request Bodyapplication/json
jobIdstringrequired

The ID of the import job in concern

clusterIdstringrequired

The ID of a cluster to which this operation applies.

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/vectordb/jobs/import/getProgress" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
-d '{
    "clusterId": "inxx-xxxxxxxxxxxxxxx",
    "jobId": "job-xxxxxxxxxxxxxxxxxxxxx"
}'
Responses200 - application/json
codestring

Response code.

dataobject

Response payload.

jobIdstring

ID of an import job.

collectionNamestring

Target collection name of the import job.

fileNamestring

Path of the data file object in the object storage.

fileSizeinteger

Size of the data file object.

statestring

State of this import job.

progressinteger

Progress in percentage of the current import job.

completeTimestring

Timestamp indicating when the import job is complete.

reasonstring

Reason for the failure to import data. The value will be an empty string when the import job is successful.

totalRowsinteger

Number of rows in the specified collection.

detailsarray

Statistics on data import oriented to data files.

[]detailsobject

Detailed information about the processing of a source data file.

fileNamestring

The name of a data file.

fileSizeinteger

The size of the data file.

statestring

The processing state of the data file.

progressinteger

The progress in percentage.

completeTimestring

The timestamp at which the file is processed.

reasonstring

The reason for the failure to import data. The value will be an empty string when the data file is successfully processed.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "jobId": "job-xxxxxxxxxxxxxxxxxxxxx",
        "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": ""
            }
        ]
    }
}