View the details of a tenant

On the details page of a tenant, you can delete the tenant, add a replica, change the password, lock the tenant, and copy the tenant. You can also view the basic information of the tenant, view replica details, and modify zone priorities and the allowlist.

OceanBase Cloud Platform (OCP) allows you to create associated primary and standby tenants in different clusters. Take note of the following considerations on the primary and standby tenants:

• If you modify the tenant configurations, the modification may affect the synchronization efficiency between the primary and standby tenants and the tenant performance. In this case, we recommend that you configure the same settings for the primary and standby tenants.
• If network-based synchronization is used between the primary and standby tenants and archiving is disabled for the primary tenant, REDO logs of the primary tenant may be overwritten before being synchronized to the standby tenant. In this case, we recommend that you enable log archiving for the primary tenant.

Prerequisites

Make sure that you have the following permissions:

• Resource Permissions : Cluster Read-only or Tenant Read-only permission
• Menu Permissions : Permission on the Overview menu of Tenants

View basic information

You can view basic tenant information in the following fields: Tenant Name , Tenant ID , Cluster , OceanBase version number, Tenant Mode , Character Set , Collation, Load Type , Locality , OBProxy/Connection String , Binlog Service , Tag , Lock , Created At , Limitations , Remarks , and Arbitration Service .

• You can click the name of the cluster to go to its details page. For more information, see View the details of a cluster.

• You can click the Copy icon next to the name of a tenant to copy its name.

• You can View next to OBProxy/Connection String , and copy the connection string in the dialog box that appears.

  • Connection String : The connection string can be obtained when the cluster of the tenant is associated with the OBProxy.

  • You can associate the cluster with the OBProxy through direct connection. Here is an example:

    obclient -Pxxx.xxx.xxx.xxx0 -u<Username>@<Tenant name#Cluster name> -P2883 -p****** -c -A sys
    

• You can click Add Service Name to add a service name. The service name must start with a letter and can contain letters, digits, and underscores (_). It must be 2 to 64 characters in length. You can also edit or delete the added service name in the Actions drop-down list. You can select the Sync Service Names of Primary and Standby Tenants option for the primary and standby tenants.

  Note

  • You can configure a service name for a tenant only when the following version requirements are met:
    • OceanBase Database: V4.2.1.9, [V4.2.4.0, V4.3.0.0), or [V4.3.3.0, +∞)
    • OBProxy: [V4.3.1.0, +∞)
  • We recommend that you set the same service name for the primary and standby tenants, and that the clusters to which the primary and standby tenants belong be associated with the same OBProxy cluster. This way, your application can implement automatic routing after a switchover.
  • For more information, see Manage service names.

• You can enable the binlog service for a tenant. For more information, see Manage the binlog service for a tenant.

• You can hover the pointer over the Tag field to view all tags of the tenant. You can click the Edit icon to manage the tags. For more information, see Manage tags.

• You can click View next to Limitations to view the resource usage limits for the tenant under the current resource specifications. When the resource usage approaches the threshold, upgrade the resource specifications for the tenant to avoid database exceptions.

  Note

  You can view the resource usage limitations for a tenant only if the cluster to which the tenant belongs meets the following version requirements:

  • OceanBase Database V4.2.x: V4.2.4 or later
  • OceanBase Database V4.3.x: V4.3.1 or later

• You can click the icon next to Remarks to modify the description.

• You can click the icon next to Arbitration Service to enable or disable the arbitration service.

• You can perform other management operations on the tenant. For more information, see Delete a tenant, Add a replica, Change the password of the sys tenant, Rename a tenant, Lock a tenant, Copy a tenant, Clone a tenant, and Configure full-link tracking for a tenant.

View replica details

You can view the zone names, replica types, unit specifications, and number of units, and modify or delete a replica. For more information, see Edit a tenant replica in a zone and Delete a tenant replica from a zone.

View the zone priorities

You can view or modify the distribution priorities of partition leaders in the tenant. For more information, see Modify zone priorities.

View the allowlist

You can view or modify the IP addresses that can connect to the tenant. For more information, see Modify the allowlist.

Perform tenant management operations

You can perform routine tenant management operations by using the options in the left-side navigation pane. For more information, see View the topology of a tenant, Manage databases, Manage users in a MySQL tenant, Manage user under an Oracle tenant, View the performance and SQL monitoring data of a tenant, View transaction performance data, View storage and cache monitoring data, View OBKV-Table monitoring data, View OBKV-HBase monitoring data, Manage resources of a tenant, Diagnose suspicious SQL statements, Diagnose transactions, View major compaction details of a tenant, Back up a tenant now, View parameters, and Manage tenant parameter templates.