使用 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
針對特定服務,請僅執行其中一個指令。以下範例使用 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 ` 值不為零,即表示發生錯誤。成功的回應可省略 `code `,因其值為零。若任務失敗或超時,請在從該備份還原前,先檢查回應詳細資訊及伺服器日誌。
列出儲存的備份,並按名稱檢查已完成的備份:
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 上會選取快照。若要明確請求二進位日誌,請在 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"
}'
HTTPcollection_names 欄位會在套用後綴之前,從備份中選取名稱。此請求會選取coll 並建立coll_bak 。CLI 的--filter 則是在重新命名後匹配目標名稱;請勿將coll_bak 代入此 HTTP 欄位。
從還原回應中複製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 。驗證程式碼會讀取還原後的資料,但不會刪除該資料。針對生產環境資料,請與備份時擷取的基準資料進行比對。