Restore from Backup Files
This guide walks you through how to restore clusters or collections from a listed backup file. You can only restore the backup files in the AVAILABLE state.
Before you start
Make sure the following conditions are met:
- You are granted the Organization Owner or Project Admin role in the target organization.
Restore a cluster
- Cloud Console
- Bash
Navigate to the Backups page, locate your target backup file. If you need to restore a cluster, the type of the target backup file should be Cluster. Click ... in the Actions column and select Restore Cluster.
Set the attributes for the cluster to be restored from the backup file.
While setting these attributes, note that:
-
You can restore from a backup file to create a target cluster in a different project, but not in a different cloud provider and region.
-
You can choose to retain the load status of the collections in the target cluster.
-
You can rename the target cluster and reset its CU size and password, but not its CU type.
Once you click Restore, Zilliz Cloud will start creating the target cluster with the specified attributes and then restore the collections in the backup file to the target cluster. A new restoration job will be generated. You can check the cluster restoration progress on the Jobs page. When the job status switches from IN PROGRESS to SUCCESSFUL, the restoration is complete.
Restore a cluster. For details on parameters, refer to Restore Cluster Backup.
curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/${BACKUP_ID}/restoreCluster" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-type: application/json" \
--data-raw '{
"targetProjectId": "proj-20e13e974c7d659a83xxxx",
"clusterName": "Dedicated-01-backup",
"cuSize": 1,
"collectionStatus": "KEEP"
}'
Expected output:
{
"code": 0,
"data": {
"clusterId": "in01-4a96cde32afxxxx",
"username": "db_admin",
"password": "Th0]sT4137WOxxxx"
}
}
Restore a collection
- Cloud Console
- Bash
Navigate to the Backups page, locate your target backup file. If you need to restore a collection, the type of the target backup file should be Collection. Click ... in the Actions column and select Restore Collection.
Set the attributes for the collection to be restored from the backup file.
While setting these attributes, note that:
-
You can restore from a backup file to create a target collection in a different project and a different running cluster.
-
You can choose to load or unload the target collection.
-
You can rename the target collection.
Once you click Restore, Zilliz Cloud will start creating the target collection with the specified attributes. A new restoration job will be generated. You can check the collection restoration progress on the Jobs page. When the job status switches from IN PROGRESS to SUCCESSFUL, the restoration is complete.
Restore a collection. For details on parameters, refer to Restore Collection Backup.
curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/${BACKUP_ID}/restoreCollection" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-type: application/json" \
--data-raw '{
"targetProjectId": "proj-20e13e974c7d659a83xxxx",
"targetClusterId": "in01-3e5ad8adc38xxxx",
"dbCollections": [
{
"collections": [
{
"collectionName": "medium_articles",
"targetCollectionName": "restore_medium_articles",
"targetCollectionStatus": "LOADED"
}
]
}
]
}'
Expected output:
{
"code": 0,
"data": {
"jobId": "job-04bf9335838dzkeydpxxxx"
}
}