Skip to main content

listImportJobs()

Lists bulk import jobs in Milvus or Zilliz Cloud.

java
public static String listImportJobs(String url, BaseListImportJobsRequest request)

Request Syntax

Use this request to list import jobs in Zilliz Cloud.

java
CloudListImportJobsRequest.builder()
.apiKey(apiKey)
.clusterId(clusterId)
.projectId(projectId)
.regionId(regionId)
.pageSize(pageSize)
.currentPage(currentPage)
.build();

PARAMETERS:

  • apiKey (String) -
    Authentication credential. Use the Zilliz Cloud API key for Cloud requests or username:password for Milvus requests.

  • clusterId (String) -
    Cluster identifier for cluster-based deployments. For project database deployments, use projectId and regionId instead.

  • projectId (String) -
    Project identifier for project database deployments. Use with regionId instead of clusterId.

  • regionId (String) -
    Region identifier for project database deployments. Use with projectId instead of clusterId.

  • pageSize (Integer) -
    Number of import jobs to return per page.

  • currentPage (Integer) -
    One-based page number to return.

RETURNS:

String

A JSON response containing the matching import jobs and pagination details.

Example

Lists import jobs for a Zilliz Cloud project database.

java
CloudListImportJobsRequest request = CloudListImportJobsRequest.builder()
.projectId(PROJECT_ID)
.regionId(REGION_ID)
.currentPage(1)
.pageSize(10)
.apiKey(API_KEY)
.build();
String response = BulkImportUtils.listImportJobs("https://api.cloud.zilliz.com", request);
Minimum SDK versionv2.5.x
Ctrl I