View the details of a cluster|V4.3.5| docs|Distributed Database

View the details of a cluster

Last Updated：2025-04-02 06:36:34 Updated

On the Overview page of a cluster, you can view its basic information, resource usage, alerts, system events of the last seven days, zones, and OBServer nodes, and can perform routine cluster maintenance.

Prerequisites

Make sure that you have the following permissions:

Resource Permissions : Cluster Read-only permission
Menu Permissions : Permission on the Overview menu of Clusters

View basic information

On the overview page of a cluster, you can view the basic information of the cluster in the following fields: Cluster Name , Cluster ID , Cluster Type , OceanBase version number, Regions , Deployment Mode , CPU Architecture , Cgroup Configuration , CPU Overallocation Quota , Servers , Load Type , Partitions , Tenants , Created By , OBProxy Cluster , Log Transfer Mode , Synchronization Status , Protection Mode , Software Installation Path , Data Disk Path , Log Disk Path , ConfigUrl, and Label .

Parameter	Description
Cluster Name	The name of the cluster. You can click the Copy icon next to the cluster name to copy it.
Cluster ID	The unique ID of the cluster, which is automatically generated when the cluster was created.
Cluster Type	The type of the cluster. Valid values: Primary Cluster and Standby Cluster . Note If the cluster version is OceanBase Database V4.0 or later, the cluster type is no longer displayed.
OceanBase version number	The OceanBase Database version of the cluster.
Regions	The number of regions in the cluster.
Deployment Mode	The deployment mode of the cluster. The value 1 indicates that the cluster has one zone, and the zone has one host. The value 1-1 indicates that the cluster has two zones, and each zone has one host. The value N-N-...N (M Ns) indicates that the cluster has M zones, and each zone has N hosts.
CPU Architecture	OCP automatically identifies the hardware architecture of the host when the host is added. If multiple different hardware architectures exist in the cluster, the information about all hardware architectures is displayed.
Cgroup configuration	Indicates whether the cgroup feature is enabled for the cluster. You can click Edit to enable or disable this feature. Note If your business involves a single tenant and less than 14 CPU cores and requires high database performance, we recommend that you disable the cgroup feature. If the operating system kernel version on the host is earlier than V4.1.9, you cannot create tenants in the cluster. In this case, the cgroup feature is disabled by default, and you cannot enable it. Enabling or disabling the cgroup feature restarts the cluster. Proceed with caution.
CPU Overallocation Quota	Indicates whether CPU overprovisioning is enabled for the cluster. You can click Edit to enable or disable this feature. Note CPU overprovisioning is supported only in OceanBase Database V4.0 and later. CPU overprovisioning depends on the cgroup configuration. Enable the cgroup feature for the cluster before you configure the CPU overprovisioning quota.
Servers	The number of hosts in the cluster.
Load Type	The load type of the cluster. You can click the Edit icon to change the load type.
Partitions	The number of partitions of tables in the cluster. Note If the cluster version is OceanBase Database V4.0 or later, the number of partitions is no longer displayed.
Tenants	The number of tenants in the cluster.
Created By	The username of the user that created the cluster.
OBProxy Cluster	The OBProxy cluster that is associated with the current OceanBase cluster. If the cluster is not associated with an OBProxy cluster, click Associate OBProxy Cluster to associate it with one or more OBProxy clusters. If the cluster is associated with OBProxy clusters, you can click the Edit icon to add or delete OBProxy clusters.
Protection Mode	This parameter is displayed only for the primary cluster. For more information, see Protection modes. Note If the cluster version is OceanBase Database V4.0 or later, the protection mode is no longer displayed.
Software Installation Path	The software installation path specified when the cluster was created.
Data Disk Path	The data disk path specified when the cluster was created.
Log Disk Path	The log disk path specified when the cluster was created.
Log Transfer Mode	This parameter is displayed for a standby cluster. Valid values: Synchronous and Asynchronous . When the log transfer mode is Synchronous, the synchronization mode can be Asynchronous, depending on the protection mode.
Synchronization Status	The latency of log transfer. This parameter is displayed for a standby cluster.
ConfigUrl	The cluster URL. You can click the Copy icon to copy it.
Tag	A tag that is set based on the content and attributes of the cluster. You can hover the pointer over the `Tag` field to view all tags of this cluster. You can click the Edit icon to manage the tags. For more information, see Manage tags.

View resource usage

In the Resource Usage section, you can view the following information about the current cluster: Allocated CPU , Allocated Memory , Allocated Log Disk , and Data Disk Used . You can manage the cluster based on the resource usage.

Note

If CPU overprovisioning is enabled for the cluster, the maximum and minimum numbers of allocated CPU cores are displayed in the ** Resource Usage ** section.

If the cluster version is earlier than OceanBase Database V4.0, the Allocated Log Disk information is not displayed in the Resource Usage section.

View alerts

In the Alert Overview section, you can view different types of alerts, including cluster alerts, tenant alerts, OBServer node alerts, and log alerts.

View system events in the last seven days

You can set query conditions in the System Events in Last 7 Days section to query the system events in the last seven days.

You can specify a time range in the time selection field.
You can filter events in the Event Name column.
You can filter events by module.
You can sort events in ascending or descending order by start time.

The system lists the system events that meet the foregoing conditions you specified.

View zones

In the Zones section, you can view the following zone parameters and search for zones by these parameters: Zone Name , Region , IDC , Servers , RootService, CPU Architecture , and Status . The Actions column provides the following options: Add OBServer , Edit , Restart , Stop , and Delete . For more information, see Add an OBServer node, Edit a zone, Restart a zone, Stop a zone, and Delete a zone.

View OBServer nodes

In the OBServer node list, you can view information about OBServer nodes in the following columns: IP, SQL Port , RPC Port , Zone , Host Type , Resource Usage (CPU, Memory, Log Disk, and Data disk), and Status .

When an OBServer node becomes unavailable, hover the pointer over the Unavailable icon to view the duration and cause of the unavailability and the corresponding solution.
The Actions column provides the following options: Restart , Stop Service , Stop Process , Reinstall , Replace , Delete , and Download Logs . For more information, see Restart an OBServer node, Stop an OBServer service, Stop the observer process, Reinstall an OBServer node, Replace an OBServer node, Delete an OBServer, and Download logs.

Note

If CPU overprovisioning is enabled for the cluster, the maximum and minimum numbers of allocated CPU cores are displayed in the Resource Usage section.

The Log Disk data is displayed in the Resource Usage section only for a cluster whose version is earlier than OceanBase Database V4.0.

View the arbitration service list

In the Arbitration Service List section, you can view the following arbitration service parameters: Service Address , Communication Status, Added At , and Service-Enabled Tenants . You can click the service address to go to the arbitration service management page. The Actions column provides the following options: Add Arbitration Service , Replace Service , and Remove Service. For more information, see Add an arbitration service, Replace an arbitration service, and Remove an arbitration service.

Perform cluster management operations

You can perform basic cluster management operations on the Overview page of a cluster. For more information, see Add an OBServer node, Add a zone, Create a tenant, Create a standby cluster, Upgrade a cluster, Change the password of the sys tenant, Restart a cluster, Stop a cluster, Delete a cluster, Decouple a standby cluster from the primary cluster, Enable automatic detection of deadlocks, Disable automatic detection of deadlocks, Manage CPU core binding configurations, Overview, and Download logs.

You can also perform routine O&M operations on a cluster by using the options in the left-side navigation pane. For more information, see View the topology of a cluster, Manage tenants, View performance monitoring, Performance report, Manage cluster resource, Manage major compaction of a cluster, Cluster backup and restore, and Manage cluster parameters.

Protection modes

Maximum performance: It protects user data and maximizes the performance of the primary cluster. In this mode, the log transfer between the primary cluster and all standby clusters is asynchronous.
Maximum availability: Normally, the primary cluster keeps synchronous log transfer with only one standby cluster.
Maximum protection: The primary cluster keeps synchronous log transfer with only one standby cluster, and asynchronous log transfer with other standby clusters.

Switch between clusters

To view the information about another cluster, click the cluster name in the upper-left corner of the Overview page and select the target cluster to switch to its overview page.

09081111