list_restore_snapshot_jobs()

此操作会列出所有恢复快照作业。您也可以按 Collection 名称进行筛选，以查看针对特定 Collection 的恢复作业。

请求语法

python
list_restore_snapshot_jobs(
    collection_name: str = "",
    timeout: Optional[float] = None,
    **kwargs
) -> List[RestoreSnapshotJobInfo]

参数：

collection_name (str) -
用于筛选恢复作业的可选 Collection 名称。如果为空，则列出所有恢复作业。
timeout (Optional[float]) -
允许 RPC 执行的可选时长，单位为秒。

返回类型：

List[RestoreSnapshotJobInfo]

返回：

返回一个 RestoreSnapshotJobInfo 对象列表，其中每个对象都包含恢复作业信息，具有以下字段：

python
{
    'job_id': int,
    'snapshot_name': str,
    'db_name': str,
    'collection_name': str,
    'state': str,
    'progress': int,
    'reason': str,
    'start_time': int,
    'time_cost': int
}

参数：

job_id (int) -

恢复作业 ID。
snapshot_name (str) -

正在恢复的快照名称。
db_name (str) -

目标 Database 名称。
collection_name (str) -

目标 Collection 名称。
state (str) -

当前状态。可能的值包括：RestoreSnapshotNone、RestoreSnapshotPending、RestoreSnapshotExecuting、RestoreSnapshotCompleted、RestoreSnapshotFailed。
progress (int) -

进度百分比（0-100）。
reason (str) -

作业失败时的错误原因。
start_time (int) -

开始时间戳，单位为毫秒。
time_cost (int) -

耗时，单位为毫秒。

异常：

MilvusException

如果操作失败。

示例

python
from pymilvus import MilvusClient

client = MilvusClient(uri="YOUR_CLUSTER_ENDPOINT")

# List all restore jobs
jobs = client.list_restore_snapshot_jobs()
for job in jobs:
    print(f"Job {job.job_id}: {job.snapshot_name} -> {job.collection_name} ({job.state})")

# Filter by target collection
jobs = client.list_restore_snapshot_jobs(collection_name="my_collection")

请求语法​

示例​

请求语法

示例