milvus-logo
LFAI
< Docs
  • RESTful
    • v2
      • Import (v2)

Get Import Job Progress

POST
http://${MILVUS_URI}/v2/vectordb/jobs/import/get_progress

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

Example

export MILVUS_URI="localhost:19530"

curl --location --request POST "http://${MILVUS_URI}/v2/vectordb/jobs/import/get_progress" \
--header "Content-Type: application/json" \
--data-raw '{
    "jobId": 44870776388440916
}'

Possible response is similar to the following.

{
    "code": 0,
    "data": {
        "collectionName": "quick_setup",
        "completeTime": "2024-04-01T06:17:55Z",
        "details": [
            {
                "completeTime": "2024-04-01T06:17:53Z",
                "fileName": "id:448761313698322012 paths:\"a6fb2d1c-7b1b-427c-a8a3-178944e3b66d/1.parquet\" ",
                "fileSize": 3279917,
                "importedRows": 100000,
                "progress": 100,
                "state": "Completed",
                "totalRows": 100000
            }
        ],
        "fileSize": 3279917,
        "importedRows": 100000,
        "jobId": "448761313698322011",
        "progress": 100,
        "state": "Completed",
        "totalRows": 100000
    }
}

Request

Parameters

  • Header parameters

    ParameterDescription
    Request-Timeoutinteger
    The timeout duration for this operation.
    Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.
    Authorizationstring
    The authentication token.
  • No query parameters required

  • No path parameters required

Request Body

{
    "dbName": "string",
    "jobId": "string"
}
ParameterDescription
dbNamestring
The name of the target database of this operation..
jobId *string
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.

Response

Returns the import job progress in detail.

Response Bodies

  • Response body if we process your request successfully
{
    "code": "integer",
    "data": {
        "collectionName": "string",
        "completeTime": "string",
        "details": [
            {
                "completeTime": "string",
                "fileName": "string",
                "fileSize": "string",
                "progress": "string",
                "state": "string",
                "reason": "string",
                "importedRows": "string",
                "totalRows": "string"
            }
        ],
        "fileSize": "integer",
        "jobId": "integer",
        "progress": "integer",
        "state": "string",
        "reason": "string",
        "importedRows": "integer",
        "totalRows": "integer"
    }
}
  • Response body if we failed to process your request
{
    "code": integer,
    "message": string
}

Properties

The properties in the returned response are listed in the following table.

PropertyDescription
codeinteger
Indicates whether the request succeeds.
  • 200: The request succeeds.
  • Others: Some error occurs.
messagestring
Indicates the possible reason for the reported error.
dataobject
data.collectionNamestring
The name of the target collection of this bulk-import job.
data.completeTimestring
The timestamp indicating when the bulk-import job is complete.
data[].detailsarray
Statistics on data import oriented to data files.
data[].details[]object
Statistics on data import from a file.
data[].details[].completeTimestring
The timestamp at which the file is processed.
data[].details[].fileNamestring
The name of a data file.
data[].details[].fileSizestring
The size of the data file.
data[].details[].progressstring
The progress in percentage.
data[].details[].statestring
The processing state of the data file. Possible values are Pending, Importing, Completed, and Failed.
data[].details[].reasonstring
The reason for the failure to bulk import data.
data[].details[].importedRowsstring
The number of rows imported from this file.
data[].details[].totalRowsstring
The number of rows in the specified collection upon the import from this file is complete.
data.fileSizeinteger
The uploaded file size in bytes.
data.jobIdinteger
The ID of this bulk-import job.
data.progressinteger
The progress in percentage of the current bulk-import job.
data.statestring
The state of this bulk-import job. Possible values are Pending, Importing, Completed, and Failed.
data.reasonstring
The reason for the failure to bulk import data.
data.importedRowsinteger
The number of rows inserted into the specified collection upon this import.
data.totalRowsinteger
The number of rows in the specified collection.