メインコンテンツまでスキップ

list_restore_snapshot_jobs()

この操作は、すべての復元スナップショットジョブを一覧表示します。必要に応じてコレクション名でフィルタリングし、特定のコレクションを対象とする復元ジョブを確認できます。

Request Syntax​

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

PARAMETERS:

  • collection_name (str) -
    復元ジョブをフィルタリングするための任意のコレクション名です。空の場合は、すべての復元ジョブが一覧表示されます。

  • timeout (Optional[float]) -
    RPC に許可する任意のタイムアウト時間（秒単位）です。

RETURN TYPE:

List[RestoreSnapshotJobInfo]

RETURNS:

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
}

PARAMETERS:

  • job_id (int) -

    復元ジョブ ID。

  • snapshot_name (str) -

    復元対象のスナップショット名。

  • db_name (str) -

    対象データベース名。

  • collection_name (str) -

    対象コレクション名。

  • state (str) -

    現在の状態。指定可能な値: RestoreSnapshotNone、RestoreSnapshotPending、RestoreSnapshotExecuting、RestoreSnapshotCompleted、RestoreSnapshotFailed。

  • progress (int) -

    進行率のパーセンテージ（0～100）。

  • reason (str) -

    ジョブが失敗した場合のエラー理由。

  • start_time (int) -

    開始タイムスタンプ（ミリ秒）。

  • time_cost (int) -

    所要時間（ミリ秒）。

EXCEPTIONS:

  • MilvusException

    操作が失敗した場合。

Examples​

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")
Ctrl I