List Import Jobs

List all import jobs specific to a cluster.

---

GET

https://controller.${CLOUD_REGION}.zillizcloud.com/v1/vector/collections/import/list

---

Example

📘Notes

This API requires an API key as the authentication token.

export CLOUD_REGION="gcp-us-west1"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
export API_KEY=""

curl --location --request GET "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/vector/collections/import/list?clusterId=${CLUSTER_ID}&pageSize=10&currentPage=1" \
--header "Authorization: Bearer ${API_KEY}"

Possible return is similar to the following.

{
    "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
    }
}

Request

Parameters

• Query parameters

  Parameter	Description
  clusterId	string(required) The ID of a specific cluster on Zilliz Cloud.
  pageSize	string The number of records to return at each request.
  currentPage	string The current page number.

• No path parameters required

• Header parameters

  Parameter	Description
  Authorization	string

Request Body

No request body required

Response

Returns a list of import jobs.

Response Body

{
    "code": "string",
    "data": {
        "count": "string",
        "currentPage": "string",
        "pageSize": "string",
        "records": [
            {
                "collectionName": "string",
                "jobId": "string",
                "state": "string"
            }
        ]
    }
}

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
data	object
data.count	string Total number of records listed in this response.
data.currentPage	string The current page number for your reference.
data.pageSize	string The maximum number of records to be included in each return.
data[].records	array
data[].records[]	object
data[].records[].collectionName	string The target collection name of a import task.
data[].records[].jobId	string The ID of an import task.
data[].records[].state	string The corresponding status of the import task. Possible values are ImportRunning, ImportCompleted and ImportFailed.

Error Response

{
    "code": integer,
    "message": string
}

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
message	string Indicates the possible reason for the reported error.