Skip to main content

Migrate to New Dedicated Cluster

Create a dedicated cluster and migrate data from the source cluster to the new cluster.

POST
/v2/migrations/toNewDedicated
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
clusterNamestringrequired

The name of the destination cluster to create.

projectIdstringrequired

The ID of the project to create the destination cluster in.

regionIdstringrequired

The ID of the cloud region to create the destination cluster in.

planstringrequired

The subscription plan to use for the destination cluster.

cuTypestringrequired

The CU type to use for the destination cluster.

cuSizeintegerrequired

The CU size to use for the destination cluster.

Value Range: ≥ 1≤ 256
dbCollectionsarray

A list of source- and destination-database pairs in the migration.

[]dbCollectionsobject
dbNamestring

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

destDbNamestring

The name of the destination database.

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/migrations/toNewDedicated" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "source": {
        "clusterId": "inxx-xxxxxxxxxxxxxx"
    },
    "destination": {
        "clusterName": "Cluster-01",
        "projectId": "proj-xxxxxxxxxxxxxxxxxxxx",
        "regionId": "aws-us-west-2",
        "plan": "Standard",
        "cuType": "Performance-optimized",
        "cuSize": 1
    }
}'
Responses200 - application/json
codeinteger

Response code.

dataobject
clusterIdstring

The ID of the destination cluster.

usernamestring

The username used to access the destination cluster.

passwordstring

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

jobIdstring

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

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "clusterId": "inxx-xxxxxxxxxxxxxx",
    "username": "db_admin",
    "password": "xxxxxxxxx",
    "jobId": "job-xxxxxxxxxxxxxxxxxxxxxx"
}