Create Backup
Backups are point-of-time copies of a managed cluster or a specific collection on Zilliz Cloud. You can use it as a baseline for new clusters and collections or just for data backup.
Manually created backups are permanently retained on Zilliz Cloud, which means they will not be automatically deleted.
Before you start
Make sure the following conditions are met:
-
You are granted the Organization Owner or Project Admin role in the target organization.
-
Your cluster runs on the Dedicated tier.
Backups are available only to the Dedicated clusters. If your cluster runs on the Free, upgrade it first. If your cluster runs on the Serverless tier, migrate it to a dedicated cluster first. Creating backups may incur charges. For more information about backup cost, please refer to Understand Cost.
Create backup
- Cloud Console
- Bash
You can create a backup file of your cluster or collection based on the following figure. Your cluster is still in service while Zilliz Cloud is creating the backup file.
You can create a backup for an entire cluster or a specific collection. For details on parameters, refer to Create Backup.
-
Create a backup for an entire cluster.
export BASE_URL="https://api.cloud.zilliz.com"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxx"
curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--data-raw '{
"backupType": "CLUSTER"
}'Expected output:
{
"code": 0,
"data": {
"backupId": "backup0_c7b18539b97xxxx",
"backupName": "Dedicated-01_backup2",
"jobId": "job-031a8e3587ba7zqkadxxxx"
}
} -
Create a backup for a specific collection.
export BASE_URL="https://api.cloud.zilliz.com"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxx"
curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"backupType": "COLLECTION",
"dbCollections": [
{
"collectionNames": [
"medium_articles"
]
}
]
}'Expected output:
{
"code": 0,
"data": {
"backupId": "backup11_4adb19e3f9exxxx",
"backupName": "medium_articles_bacxxxx",
"jobId": "job-039dbc113c5ozfwunvxxxx"
}
}
A backup job will be generated. You can check the backup progress on the Jobs page. When the job status switches from IN PROGRESS to SUCCESSFUL, the backup is created successfully.
Within the same cluster, only one manually created backup job can be in progress or pending at a time. You can manually create another backup file when the previously requested job is completed.
Please note that the time it takes to create a backup varies. For cluster backups, it depends on the size of the cluster and the size of the CUs accommodating the cluster. For example, a single-collection cluster holding over 120 million records of 128-dimensional vectors on a 4-CU instance takes approximately 5 minutes to create a backup file.