Skip to main content

Restore Cluster Backup

Restore cluster backup to a new dedicated cluster of the same CU type in the same cloud region. Note that this API only applies to dedicated clusters.

POST
/v2/clusters/{CLUSTER_ID}/backups/{BACKUP_ID}/restoreCluster
Base URL

The base URL for this API is in the following format:

https://api.cloud.zilliz.com

export BASE_URL="https://api.cloud.zilliz.com"
Parameters
Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}
CLUSTER_IDstringpathrequired

The ID of the cluster whose backup is in concern.

Example Value: inxx-xxxxxxxxxxxxxxx
BACKUP_IDstringpathrequired

The ID of the backup in concern.

Example Value: Dedicated-01_backup3
Request Bodyapplication/json
projectIdstringrequired

The ID of the project to which the restored cluster belongs.

clusterNamestringrequired

The name of the restored cluster.

cuSizeintegerrequired

The CU size allocated to the restored cluster.

Value Range: ≥ 1≤ 256
collectionStatusstringrequired

The status of the collections in the restored cluster.

export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"
export BACKUP_ID="Dedicated-01_backup3"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/backups/${BACKUP_ID}/restoreCluster" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "projectId": "proj-xxxxxxxxxxxxxxxxxxxx",
    "clusterName": "Dedicated-12",
    "cuSize": 2,
    "collectionStatus": "KEEP"
}'
Responses200 - application/json
codeinteger

Response code.

dataobject

Response payload which is the information of the restored cluster.

clusterIdstring

The ID of the restored cluster.

usernamestring

The username used to access the restored cluster.

passwordstring

The password used to access the restored cluster. This is shown only once. You are advised to note down the password and save it in a secure place.

jobIdstring

The ID of the cluster restoration job created upon this request.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "username": "db_admin",
        "password": "xxxxxxxxx",
        "jobId": "job-xxxxxxxxxxxxxx"
    }
}