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

List Import Jobs

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

This operation lists all bulk-import jobs of a specific cluster.

Example

export MILVUS_URI="localhost:19530"

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

Possible response is similart to the following.

{
    "code": 0,
    "data": {
        "records": [
            {
                "collectionName": "quick_setup",
                "jobId": "448761313698322011",
                "progress": 50,
                "state": "Importing"
            }
        ]
    }
}

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

{
    "collectionName": "string",
    "dbName": "string"
}
ParameterDescription
collectionNamestring
The name of the target collection.
Setting this to a non-existing collection results in an error.
dbNamestring
The name of the database to which the collection belongs.
Setting this to a non-existing database results in an error.

Response

A dictionary of all existing import jobs.

Response Bodies

  • Response body if we process your request successfully
{
    "code": "integer",
    "data": {
        "records": [
            {
                "collectionName": "string",
                "jobId": "integer",
                "state": "string",
                "progress": "integer",
                "reason": "string"
            }
        ]
    }
}
  • 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[].recordsarray
A list of import jobs.
data[].records[]object
data[].records[].collectionNamestring
The name of the target collection of this bulk-import job.
data[].records[].jobIdinteger
The ID of this bulk-import job.
data[].records[].statestring
The state of this bulk-import job. Possible values are Pending, InProgress, Completed, and Failed.
data[].records[].progressinteger
The progress in percentage of the current bulk-import job.
data[].records[].reasonstring
The reason for the failure to bulk import data.