Version: User Guides (BYOC)

Connect to Cluster
Contact Sales to Enable BYOC

This article offers a systematic guide on connecting to a cluster.

Before you start

Ensure the following prerequisites are met before proceeding:

You have deployed a BYOC project. For details, see
You have completed the network configurations between your application and the clusters in the BYOC project. For details, refer to Connect to BYOC Clusters.
You have created a cluster. For details, see Create Cluster.
You have installed a Milvus SDK applicable to your use case. For details, see Install SDKs.

📘Note

For those leaning towards the utilization of RESTful APIs over SDKs, it's important to understand that a continuous connection cannot be established. This is attributed to the HTTP protocol's unidirectional communication mode.

In BYOC deployments, use cluster credentials (username:password) to connect to clusters. API keys are for Platform API operations only and cannot be used for data plane (Milvus SDK/client) connections."

Connect to a cluster

Once your cluster is operational, connect to it utilizing its public endpoint and an authentication token.

Cluster public endpoint: You can obtain this on the Zilliz Cloud web console. Navigate to the Cluster Details page of the target cluster. On the Connect card, you can copy the cluster public endpoint.
Token: This token can be a cluster credential that consists of a username and password pair.

The following example shows how to connect to a cluster.

Python
Java
NodeJS
Go
cURL

# Connect using a MilvusClient object
from pymilvus import MilvusClient
CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT" # Set your cluster endpoint
TOKEN="YOUR_CLUSTER_TOKEN" # Set your token

# Initialize a MilvusClient instance
# Replace uri and token with your own
client = MilvusClient(
    uri=CLUSTER_ENDPOINT, # Cluster endpoint obtained from the console
    token=TOKEN # a colon-separated cluster username and password
)

import io.milvus.v2.client.MilvusClientV2;
import io.milvus.v2.client.ConnectConfig;

String CLUSTER_ENDPOINT = "YOUR_CLUSTER_ENDPOINT";
String TOKEN = "YOUR_CLUSTER_TOKEN";

// 1. Connect to Milvus server
ConnectConfig connectConfig = ConnectConfig.builder()
    .uri(CLUSTER_ENDPOINT)
    .token(TOKEN)
    .build();

MilvusClientV2 client = new MilvusClientV2(connectConfig);

const { MilvusClient, DataType, sleep } = require("@zilliz/milvus2-sdk-node")

const address = "YOUR_CLUSTER_ENDPOINT"
const token = "YOUR_CLUSTER_TOKEN"

// 1. Connect to the cluster
const client = new MilvusClient({address, token})

import "github.com/milvus-io/milvus/client/v2/milvusclient"

client, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
    Address: "YOUR_CLUSTER_ENDPOINT",
    APIKey:  "YOUR_CLUSTER_TOKEN",
})

curl --request POST \
  --url "YOUR_CLUSTER_ENDPOINT" \
  --header "Authorization: Bearer YOUR_CLUSTER_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"dbName": "default"}'

Before you start​

Connect to a cluster​

Before you start

Connect to a cluster