Skip to main content

List Import Jobs

List all import jobs specific to a cluster.


GET
https://controller.api.{cloud-region}.zillizcloud.com/v1/vector/collections/import/list

Example

Notes
  • This API requires an API Key as the authentication token.
curl --request GET \
--url "https://controller.api.${CLOUD_REGION}.zillizcloud.com/v1/vector/collections/import/list?clusterId=${CLUSTERID}" \
--header "Authorization: Bearer ${API_KEY}" \
--header "accept: application/json" \
--header "content-type: application/json"

Request

Parameters

  • Query parameters

    ParameterDescription
    clusterIdstring(required)
    The ID of a specific cluster on Zilliz Cloud.
    pageSizestring
    The number of records to return at each request.
    currentPagestring
    The current page number.
  • No path parameters required

Request Body

No request body required

Response

Returns a list of import jobs.

Response Bodies

  • Response body if we process your request successfully
{
"code": "string",
"data": {
"count": "string",
"currentPage": "string",
"pageSize": "string",
"records": [
{
"collectionName": "string",
"jobId": "string",
"state": "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
codestring
dataobject
data.countstring
Total number of records listed in this response.
data.currentPagestring
The current page number for your reference.
data.pageSizestring
The maximum number of records to be included in each return.
data[].recordsarray
data[].records[]object
data[].records[].collectionNamestring
The target collection name of a import task.
data[].records[].jobIdstring
The ID of an import task.
data[].records[].statestring
The corresponding status of the import task. Possible values are ImportRunning, ImportCompleted and ImportFailed.
messagestring
Indicates the possible reason for the reported error.

Possible Errors

CodeError Message
40021The cluster ID does not exist.
40022No access to this cluster. Please request access from your admin.
80000Incorrect parameter: xxx
80003The parameter value for 'pageSize' should be between 5 and 100.
80004The parameter 'currentPage' should have a value between 1 and the maximum value of Int.
80020Cluster not exist or you don't have permission.
90102The cluster does not exist in current region.
90104The clusterId parameter is empty in the request parameter.
90117Invalid domain name used