RESTful

List Import Jobs

This operation lists all import jobs of a specific cluster.

POST

/v2/vectordb/jobs/import/list

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 an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}

Acceptstringheader

Use application/json.

Example Value: application/json

Request Bodyapplication/json

dbNamestring

Name of the database to which the import job belongs.

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/vectordb/jobs/import/list" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
-d '{
    "clusterId": "inxx-xxxxxxxxxxxxxxx"
}'

Responses200 - application/json

OPTION 1

codestring

Response code.

dataobject

Response payload, which is a list of import jobs in detail.

recordsarray

List of import jobs in detail.

[]recordsobject

An import job in detail.

collectionNamestring

Name of the target collection of this import job.

jobIdstring

ID of this import job.

statestring

State of this import job.

Possible Values:

progressnumber

Progress of this import job.

reasonstring

Reason for the failure of this import job.

OPTION 2

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": {
        "count": 1,
        "currentPage": 1,
        "pageSize": 10,
        "records": [
            {
                "collectionName": "test_collection",
                "jobId": "job-xxxxxxxxxxxxxxxxxxxxx",
                "state": "Completed"
            }
        ]
    }
}

FAILURE

{
    "code": "0",
    "message": "The token is illegal."
}