API を使用したデータのバックアップと復元Compatible with Milvus Backup 0.6.x

Milvus Backup HTTP API を使用して、バックアップの作成、コレクションの復元、および非同期タスクの監視を行います。以下のスナップショットの例では、Milvus 3.0.1 以降が必要です。Backup 0.5.x については、0.5.x API ガイドを参照してください。既存のインストールについては、「Milvus Backup のアップグレード」を参照してください。

Milvus Backup の入手

以下の例は、Milvus Backup 0.6.0 で検証済みです。v0.6.0 リリースから適切なバイナリをダウンロードして解凍してください。代わりにソースからビルドする場合は、「Milvus Backup の入手」の手順に従ってください。ビルドには Go 1.26 以降が必要です。

設定ファイルの準備

「設定ファイルの準備」にある v2 の例を使用して、configs/backup.yaml を作成してください。Milvus、インスタンスのストレージ、およびバックアップ先へのアクセスを設定します。また、スナップショット操作を行うためには、Milvus サーバーがバックアップストレージにアクセスできる必要があります。

v1形式のファイルをお持ちの場合、引き続き読み込むことができます。スキーマや環境変数を変更する前に、「設定の移行」を参照してください。

バイナリが含まれるディレクトリから、設定を確認し、接続性をチェックします:

./milvus-backup config show --config configs/backup.yaml
./milvus-backup check --config configs/backup.yaml

接続性チェックの結果が「Success! 」と表示されたら、次の手順に進みます。

API サーバーを起動します

確認済みの設定を使用してサービスを起動します:

./milvus-backup server --config configs/backup.yaml

デフォルトのポートは 8080 です。別のポートを選択するには、-p を使用してください:

./milvus-backup server -p 18080 --config configs/backup.yaml

特定のサービスに対しては、これらのコマンドのうち1つだけを実行してください。以下の例ではポート8080を使用しています。別のポートを選択した場合は、URLを変更してください。Swagger UIはhttp://localhost:8080/api/v1/docs/index.html で利用可能です。

タスクのポーリング中は、サービスを稼働させたままにしてください。タスク ID およびリアルタイムの進行状況はサービスプロセスに紐づいており、プロセスが停止した後も、永続化されたバックアップはオブジェクトストレージに残ります。

データの準備

coll という名前の既存のコレクションを使用するか、「サンプルデータの準備」の手順に従って 256 エンティティのテストコレクションを作成してください。独自のデータを使用する場合は、リクエスト内のコレクション名を変更してください。結果の検証中は、テストデータを変更しないでください。

データのバックアップ

非同期のバックアップリクエストを送信します:

curl --request POST 'http://localhost:8080/api/v1/create' \
  --header 'Content-Type: application/json' \
  --data '{
    "async": true,
    "backup_name": "my_backup",
    "collection_names": ["coll"]
  }'

レスポンスには `requestId` が含まれます。リクエストの送信は、バックアップが完了したことを意味するものではありません。その値を `backup_id ` にコピーし、ポーリングを行います:

curl 'http://localhost:8080/api/v1/get_backup?backup_id=BACKUP_REQUEST_ID&backup_name=my_backup'

data.state_code が2 になるのを待ちます。API では以下のタスク状態が使用されます:

state_code意味
0初期
1実行中
2成功
3失敗
4タイムアウト

レスポンスとタスクの状態の両方を確認してください。HTTP 200 だけでは不十分です。code の値が 0 以外の場合、エラーが発生していることを示します。正常なレスポンスの場合、code の値は 0 であるため、この項目は省略可能です。タスクが失敗またはタイムアウトした場合は、そのバックアップから復元する前に、レスポンスの詳細とサーバーログを確認してください。

保存されているバックアップの一覧を表示し、名前で完了済みのバックアップを確認します:

curl 'http://localhost:8080/api/v1/list'
curl 'http://localhost:8080/api/v1/get_backup?backup_name=my_backup'

get_backup collection_backups を含む JSON メタデータを返します。バックアップファイルはダウンロードされません。別のプロセスによって作成されたバックアップの場合、名前のみのクエリでは、進行中のタスクの進捗情報を含まないメタデータが返されることがあります。アクティブなバックアップを監視する際は、現在のサービスの作成レスポンスから取得したタスク ID を使用してください。

デフォルトの形式は `auto` であり、これは Milvus 3.0 でのスナップショットを選択します。binlog を明示的に要求するには、`create` ボディに `"format": "binlog" ` を追加してください。CLI の `--for ` プリセットは、HTTP リクエストのフィールドではありません。

バックアップを保持または移動するには、オブジェクトストレージ内のディレクトリ全体をコピーします。0.6.0の転送ガイドを参照してください。

データの復元

coll_bak が既に存在していないことを確認してください。サフィックスを指定して復元リクエストを送信します:

curl --request POST 'http://localhost:8080/api/v1/restore' \
  --header 'Content-Type: application/json' \
  --data '{
    "async": true,
    "backup_name": "my_backup",
    "collection_names": ["coll"],
    "collection_suffix": "_bak"
  }'

HTTPのcollection_names フィールドは、サフィックスが適用される前に、バックアップ内の名前を選択します。このリクエストでは、coll が選択され、coll_bak が作成されます。一方、CLIの--filter は、名前変更後のターゲット名と照合します。このHTTPフィールドにcoll_bak を代入しないでください。

復元レスポンスから `data.id ` をコピーし、タスクのステータスを確認します:

curl 'http://localhost:8080/api/v1/get_restore?id=RESTORE_TASK_ID'

data.state_code: 2 が表示されるまで待機し、collection_restore_tasks で期待されるターゲットコレクションを確認してください。タスクが送信されただけでは、復元がまだ検証されたことにはなりません。

元の名前で復元する

coll が存在しないターゲットインスタンスを使用します。そのターゲットおよびバックアップ完了先が設定された別のバックアップ API サービスを起動し、次のリクエストをターゲットサービスに送信します:

curl --request POST 'http://localhost:8080/api/v1/restore' \
  --header 'Content-Type: application/json' \
  --data '{
    "async": true,
    "backup_name": "my_backup",
    "collection_names": ["coll"],
    "collection_suffix": ""
  }'

返されたタスク ID を使用して、同じサービス上のget_restore をポーリングします。復元先についてはmilvus.* を、既存のバックアップについてはbackup.storage を設定します。「設定ファイルの準備」を参照してください。

復元されたデータの確認

復元タスクが成功したら、ターゲットの Milvus インスタンスに接続し、期待されるコレクションとデータが存在することを確認します。256 エンティティのテストコレクションについては、「結果の確認」に記載されているスカラー、ベクトル、および検索の全チェックを実行してください。

元の名前で復元する場合は、coll_bak をcoll に変更してください。検証コードは、復元されたデータを削除せずに読み取ります。本番データについては、バックアップ時に取得したベースラインと比較してください。