List Import Jobs

List all import jobs specific to a cluster.

GET

/v1/vector/collections/import/list

Base URL

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

https://controller.api.${CLOUD_REGION}.zillizcloud.com

📘Notes

• You need to replace ${CLOUD_REGION} with the appropriate region for your deployment.
• To get the cloud region ID, refer to On Zilliz Cloud Console or List Cloud Regions.

export CLOUD_REGION="gcp-us-west1"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zillizcloud.com"

Parameters

Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}

clusterIdstringqueryrequired

The ID of a specific cluster on Zilliz Cloud.

Example Value: inxx-xxxxxxxxxxxxxxx

pageSizestringquery

The number of records to return at each request.

Example Value: 10

currentPagestringquery

The current page number.

Example Value: 1

export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v1/vector/collections/import/list?clusterId=inxx-xxxxxxxxxxxxxxx" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

Responses200 - application/json

SUCCESS

codestring

Response code.

dataobject

Response payload which is a list containing import jobs in detail.

countstring

Total number of records listed in this response.

currentPagestring

The current page number for your reference.

pageSizestring

The maximum number of records to be included in each return.

tasksarray

A list of import jobs in detail.

[]tasksobject

A import job in detail.

collectionNamestring

The target collection name of a import task.

jobIdstring

The ID of an import task.

statestring

The corresponding status of the import task. Possible values are ImportRunning, ImportCompleted and ImportFailed.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 200,
    "data": {
        "tasks": [
            {
                "collectionName": "medium_articles",
                "jobId": "job-xxxxxxxxxxxxxxxxxxxxxx",
                "state": "ImportRunning"
            },
            {
                "collectionName": "medium_articles",
                "jobId": "2b93fef7-xxxx-xxxx-xxxx-f82afd598ff1",
                "state": "ImportCompleted"
            }
        ],
        "count": 2,
        "currentPage": 1,
        "pageSize": 10
    }
}