List Import Jobs

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

  Parameter	Description
  request-timeout	integer The timeout duration for this operation. Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.
  Authorization	string The authentication token.

• No query parameters required

• No path parameters required

Request Body

{
    "collectionName": "string",
    "dbName": "string"
}

Parameter	Description
collectionName	string The name of the target collection. Setting this to a non-existing collection results in an error.
dbName	string 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.

Property	Description
code	integer Indicates whether the request succeeds. 200: The request succeeds. Others: Some error occurs.
message	string Indicates the possible reason for the reported error.
data	object
data[].records	array A list of import jobs.
data[].records[]	object
data[].records[].collectionName	string The name of the target collection of this bulk-import job.
data[].records[].jobId	integer The ID of this bulk-import job.
data[].records[].state	string The state of this bulk-import job. Possible values are Pending, InProgress, Completed, and Failed.
data[].records[].progress	integer The progress in percentage of the current bulk-import job.
data[].records[].reason	string The reason for the failure to bulk import data.