Milvus
Zilliz
< Docs
  • RESTful
    • About
    • v1

Get Import ProgressAbout to Deprecate

Retrieves the progress of a specified import task.

GET
/v1/vector/collections/import/get
Base URL

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

http://localhost:19530

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

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

Example Value: Bearer {{TOKEN}}
jobIdstringqueryrequired

The ID of the import task in concern

Example Value: job-xxxxxxxxxxxxxxxxxx
clusterIdstringqueryrequired

The ID of a cluster to which this operation applies.

Example Value: inxx-xxxxxxxxxxxxxxx
export TOKEN="YOUR_API_KEY"


curl --request GET \
--url "${BASE_URL}/v1/vector/collections/import/get?jobId=job-xxxxxxxxxxxxxxxxxx&clusterId=inxx-xxxxxxxxxxxxxxx" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"
Responses200 - application/json
codeinteger

Response code.

dataobject

Response payload which is an object containing the progress of the import task.

fileNamestring

The path of the data file object in the object storage.

fileSizeinteger<int64>

The size of the data file object.

readyPercentagenumber<float>

The indicator of the import progress

completeTimestring

The time at which the import task completes. null indicates that the file import is going on.

errorMessagestring

The message that explains the reason for an import failure. null indicates that no error occurs.

collectionNamestring

The target collection name of the import task.

jobIdstring

The ID of an import task.

detailsarray

The import task details

[]detailsobject

A list of import progress details per data files

fileNamestring

The path to a file being imported.

fileSizeinteger<int64>

The size of a file being imported.

readyPercentagenumber<float>

The import progress of a specific file.

completeTimestring

The time at which the import progress ends for a specific file. null indicates that the file import is going on.

errorMessagestring

The message that explains the reason for an import failure. null indicates that no error occurs.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 200,
    "data": {
        "collectionName": "medium_articles",
        "fileName": "1af78216-xxxx-xxxx-xxxx-2b0a73c566ed/1.parquet",
        "fileSize": 19599887,
        "readyPercentage": 0,
        "completeTime": "Unknown type",
        "errorMessage": "Unknown type",
        "jobId": "job-xxxxxxxxxxxxxxxxxxxxxx",
        "details": [
            {
                "fileName": "1af78216-xxxx-xxxx-xxxx-2b0a73c566ed/1.parquet",
                "fileSize": 19599887,
                "readyPercentage": 0,
                "completeTime": "Unknown type",
                "errorMessage": "Unknown type"
            }
        ]
    }
}