跳到主要内容

get_import_progress()

此函数返回批量导入任务的当前状态。

请求语法​

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

参数:

  • url (str) -
    [必需]

    Zilliz Cloud API 服务器 Endpoint,即 https://api.cloud.zilliz.com。

  • job_id (str) -
    [必需]
    要检查的导入任务的 ID。

  • cluster_id (str) -
    默认值:""
    目标 Zilliz Cloud 集群的 ID。

  • project_id (str) -
    默认值:""
    目标项目 Database 所在的 Zilliz Cloud 项目的 ID。

  • region_id (str) -
    默认值:""
    目标项目 Database 所在的 Zilliz Cloud 地域的 ID。

  • api_key (str) -
    默认值:""

    用于对请求进行身份验证的 Zilliz Cloud API key。

  • db_name (str) -
    默认值:""
    用于基于角色的访问控制、在 DB-Name 请求头中发送的 Database 名称。

  • verify (Optional[Union[bool, str]]) -
    默认值:True
    TLS 验证设置。使用 True 通过默认信任库进行验证,或提供 CA 证书路径。

  • cert (Optional[Union[str, tuple]]) -
    默认值:None
    客户端证书路径,或用于双向 TLS 认证的证书和私钥对。

  • kwargs (Any) -
    转发给 HTTP 请求的额外选项。

返回类型:

requests.Response

返回:

包含当前批量导入任务状态和进度的 HTTP 响应。

异常:

  • MilvusException
    当服务器拒绝请求或 RPC 失败时抛出。请查看服务器错误消息以了解确切的失败详情。

示例​

该示例从 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())
最低 SDK 版本v2.6.x