Skip to main content

Restore Collection Backup

Restore collection backup to an existing cluster. Note that this API only applies to dedicated clusters.

POST
/v2/clusters/{CLUSTER_ID}/backups/{BACKUP_ID}/restoreCollection
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 collection 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
destClusterIdstringrequired

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

dbCollectionsarray

A list of collection groups.

[]dbCollectionsobject

A collection group.

dbNamestring

The name of the source database containing the collections listed in the collectionNames field.

destDbNamestring

The name of the destination database to which the specified collections will be restored.

collectionsarray

Currently, Zilliz Cloud restores only one collection at a time. Therefore, include only one collection name in the list. If this is left unspecified, all collections in the backup will be restored to the target cluster unloaded.

[]collectionsobject

A collection to restore.

collectionNamestring

The name of the source collection to restore.

targetCollectionNamestring

The name of the target collection.

targetCollectionStatusstring

The status of the target collection.

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}/restoreCollection" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "destClusterId": "in01-xxxxxxxxxxxxxx",
    "dbCollections": [
        {
            "collections": [
                {
                    "collectionName": "medium_articles",
                    "targetCollectionName": "restore_medium_articles",
                    "targetCollectionStatus": "LOADED"
                }
            ]
        }
    ]
}'
Responses200 - application/json
codeinteger

Response code.

dataobject

Response payload which is the ID of an asynchronous control-plane job.

jobIdstring

The ID of a collection restoration job created upon this request.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "jobId": "job-xxxxxxxxxxxxxxxxxxxxxx"
    }
}