Global Clusters (V2)

This set of APIs provides a way to manage Global Clusters in Zilliz Cloud.

List Available Global Cluster Regions (V2) [READ MORE]

Returns region groups that can be used together in a Global Cluster. Use this API before creating a Global Cluster or adding secondary clusters.

List Global Clusters (V2) [READ MORE]

List all global clusters in the account.

Create Global Cluster (V2) [READ MORE]

This operation creates a global cluster. A global cluster consists of multiple member clusters deployed in different regions. The member clusters in a global cluster share the same CU type and CU size. You can create global clusters to provide disaster recovery and low latency access across regions.

Describe Global Cluster (V2) [READ MORE]

Returns base topology and connection information for a Global Cluster. Replication lag is intentionally excluded from this endpoint.

Get Global Cluster Replication Lag (V2) [READ MORE]

Returns replication lag from the primary cluster to each secondary cluster.

Add Secondary Clusters (V2) [READ MORE]

Adds one or more secondary clusters. New secondary clusters use the existing Global Cluster CU specification.

Delete Global Member Cluster (V2) [READ MORE]

Deletes a member cluster from a Global Cluster. A secondary member cluster can be deleted directly. The primary member cluster can be deleted only after all secondary member clusters in the same Global Cluster have been deleted.

Switchover Global Cluster (V2) [READ MORE]

Performs a planned switch from the current primary cluster to a specified secondary cluster.

Failover Global Cluster (V2) [READ MORE]

Force-promotes a specified secondary cluster as the new primary cluster.

Modify Global Cluster CU (V2) [READ MORE]

Modifies CU size or CU autoscaling policy at Global Cluster level. CU settings apply to all member clusters.

Remove Global Endpoint (V2) [READ MORE]

Disbands the Global Cluster endpoint after all secondary clusters have been removed. The remaining primary cluster continues as a regular dedicated cluster.

Convert Cluster to Global Cluster (V2) [READ MORE]

Converts an existing dedicated cluster into the primary member of a new Global Cluster, and creates one or more secondary member clusters.