Skip to main content

Migrate to Existing Cluster

Migrate data from a cluster to another.

POST
/v2/migrations/toExisting
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}}
Request Bodyapplication/json
sourceobjectrequired

The source cluster information.

clusterIdstringrequired

The ID of the source cluster.

Example Value: inxx-xxxxxxxxxxxxxxxxx
destinationobjectrequired

The destination cluster information.

clusterIdstringrequired

The ID of the destination cluster.

Example Value: inxx-xxxxxxxxxxxxxxxxxx
dbCollectionsarray

The collections that need to be migrated.

[]dbCollectionsobject

Collection information.

dbNamestring

The name of the source database. This is optional. If left unspecified, the default database applies.

destDbNamestring

The name of the destination database.

collectionsarray

The names of the collections that need to be migrated in the above specified source database. If this is left unspecified, all collections in the source database will be migrated.

[]collectionsobject

A list of collection names.

collectionNamestring

A collection name.

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/migrations/toExisting" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "source": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx"
    },
    "destination": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx"
    },
    "dbCollections": [
        {
            "collections": [
                {
                    "collectionName": "medium_articles"
                }
            ]
        }
    ]
}'
Responses200 - application/json
codeinteger

Response code.

dataobject
jobIdstring

The ID of the job that has been created upon your request.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

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