get_import_progress()

This function returns the current status of a bulk import job.

Request Syntax

python

get_import_progress(
    url: str,
    job_id: str,
    cluster_id: str = "",
    project_id: str = "",
    region_id: str = "",
    api_key: str = "",
    db_name: str = "",
    verify: Optional[Union[bool, str]] = True,
    cert: Optional[Union[str, tuple]] = None,
    **kwargs,
) -> requests.Response

PARAMETERS:

• url (str) -
  [REQUIRED]

  The Zilliz Cloud API server endpoint, which is https://api.cloud.zilliz.com.

• job_id (str) -
  [REQUIRED]
  The ID of the import job to inspect.

• cluster_id (str) -
  Default: ""
  The ID of the target Zilliz Cloud cluster.

• project_id (str) -
  Default: ""
  The ID of the Zilliz Cloud project containing the target project database.

• region_id (str) -
  Default: ""
  The ID of the Zilliz Cloud region containing the target project database.

• api_key (str) -
  Default: ""

  The Zilliz Cloud API key used to authenticate the request.

• db_name (str) -
  Default: ""
  The database name sent in the DB-Name header for role-based access control.

• verify (Optional[Union[bool, str]]) -
  Default: True
  The TLS verification setting. Use True to verify with the default trust store or provide a CA certificate path.

• cert (Optional[Union[str, tuple]]) -
  Default: None
  The client certificate path, or a certificate and private-key pair for mutual TLS.

• kwargs (Any) -
  The additional options forwarded to the HTTP request.

RETURN TYPE:

requests.Response

RETURNS:

HTTP response containing the current bulk-import job state and progress.

EXCEPTIONS:

• MilvusException
  Raised when the server rejects the request or the RPC fails. Inspect the server error message for exact failure details.

Examples

The example retrieves import progress from Zilliz Cloud.

python

from pymilvus.bulk_writer import get_import_progress

response = get_import_progress(
    url="https://api.cloud.zilliz.com",
    api_key="YOUR_API_KEY",
    project_id="proj-xxxx",
    region_id="aws-us-west-2",
    job_id="job-123",
)
print(response.json())