OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Cloud Platform

V4.0.0Enterprise Edition

  • Document Overview
  • Product Introduction
    • What is OceanBase Cloud Platform?
    • System architecture
    • Features
    • Limits
      • System requirements
      • Dependencies
  • Deployment Guide
    • Product Introduction
      • What is OceanBase Cloud Platform?
      • System architecture
    • Deployment
      • Overview
      • Deploy OCP on a single node
      • Deploy OCP clusters in the multi-cluster mode
    • Plan resources
      • OCP-Server specifications
      • MetaDB resources
      • MonitorDB resources
      • Host resources
    • Prepare the deployment environment
      • Standardize a host
      • Check the environment
    • Deploy OCP on a single node
      • Prepare installation media
      • Generate a configuration file
      • Multi-zone deployment
      • Deploy OCP
      • Register an OCP cluster
      • Initialize system parameters
    • Check after deployment
    • Deployment FAQ
      • Optimize MonitorDB parameters
      • F5 Big-IP LTM and alert configuration
        • Connect OBProxy to F5 Big-IP LTM
        • Connect OCP-Console to F5 Big-IP LTM
        • Monitor the OCP service health
      • Ubuntu deployment FAQ
      • EulerOS deployment FAQ
      • Client requirements
      • Start and stop OCP
  • Quick Start
    • OCP operations
    • Upload a software package
    • Add a host
    • Create a cluster
    • Create a tenant
    • Create a user
    • Create an OBProxy cluster
  • User Guide
    • OCP overview
    • Log on to the OCP console
    • Features
      • Clusters
        • Cluster management
        • Cluster overview
        • Overview of the cluster details page
      • Tenants
        • Tenant and resource management
        • Tenant overview
        • Overview of the Tenant Details page
      • Hosts
        • Host overview
        • Host details
      • Packages
      • OBProxy
        • OBProxy management overview
        • OBProxy overview
        • OBProxy cluster overview
      • Backup and recovery
        • Overview
        • Backup and recovery overview
        • Backup overview
        • Recovery overview
        • Services
      • Monitoring
        • Drill-down monitoring
      • Diagnostics
        • Overview of SQL diagnostics
        • Overview of transaction diagnostics
      • System management
        • Alert overview
        • View tasks
        • Inspection
        • Log service
        • Security overview
        • View system parameters
        • Historical events
        • OCP multi-cluster mode
        • Multi-zone overview
      • Personal center
        • Specify personal information
        • Change your logon password
        • Alert subscription configuration
        • Password box
        • Log off the OCP console
    • Manage clusters
      • Cluster management operations
      • Basic cluster operations
        • Take over a cluster
        • Create a cluster
        • Delete a cluster
        • Stop a cluster
        • Restart a cluster
        • Manage zones of a cluster
          • Create a zone
          • Restart a zone
          • Stop a zone
          • Delete a zone
        • Manage OBServers of a cluster
          • Add an OBServer
          • Restart an OBServer
          • Stop an OBServer service
          • Stop an OBServer process
          • Replace an OBServer
          • Delete an OBServer
        • Upgrade the version of an OceanBase cluster
        • Change the password
        • Create a standby cluster
        • Routine primary/standby cluster switchover
        • Primary/Standby cluster switchover for disaster recovery
        • Decouple a standby cluster from the primary cluster
        • Enable automatic detection of deadlocks
        • Disable automatic detection of deadlocks
        • Download logs
        • Disable SQL collection
        • iew the SQL collection history
        • Start the original primary cluster in read-only mode after a failover
      • View the topology of a cluster
      • Overview of cluster tenant management
      • Performance monitoring
      • Performance report
      • Cluster resource management
        • View unit distribution
        • View resource usage
      • Major compaction management
        • Modify the major compaction settings of a cluster
        • Details of major compaction
        • Major freeze statistics
        • Perform a major compaction
      • Cluster backup and recovery
      • Manage parameters
        • View parameters
        • Modify parameters
        • Parameter types
        • View the history of parameter changes
      • Manage cluster parameter templates
    • Manage tenants
      • Tenant management operations
      • Basic tenant operations
        • Create a tenant
        • Unit specification management
        • Create a user under an Oracle tenant
        • Lock a tenant
        • Copy a tenant
        • Delete a tenant
        • Create a replica
        • Change the password of the SYS tenant
        • Edit a tenant replica in a zone
        • Delete a tenant replica from a zone
        • Modify zone priorities
        • Modify the whitelist
      • View the topology of a tenant
      • Database management
      • User management under a MySQL tenant
      • User management under an Oracle tenant
        • User overview under an Oracle tenant
        • Create a user under an Oracle tenant
        • Change the password of a user under an Oracle tenant
        • Delete a user under an Oracle tenant
        • Create a role under an Oracle tenant
        • Manage users
        • Manage roles
      • Performance monitoring
      • Tenant resource management
      • Transaction diagnostics
      • SQL diagnostics
        • Suspicious SQL diagnostics
        • TopSQL diagnostics
        • SlowSQL diagnostics
        • ParallelSQL diagnostics
        • View SQL statement details
        • View the SQL collection enable/disable history
        • View outlines
        • View SQL request analysis
      • Tenant major compaction management
        • Modify major compaction settings of a tenant
        • Details of tenant major compaction
        • Perform a major compaction
      • Back up and recover a tenant
      • Manage sessions
        • View tenant sessions
        • View session statistics
        • View deadlock analysis
        • Manage ASH report
      • Manage parameters
        • View the parameters
        • Modify a parameter
        • View the parameter modification history
      • Manage tenant parameter templates
    • Manage hosts
      • Host management operations
      • Add a host
      • Modify a host
      • Restart OCP Agent
      • Reinstall OCP Agent
      • Host monitoring
    • Manage software packages
      • Upload a software package
      • Download a software package
      • Delete a software package
    • Manage OBProxies
      • Create an OBProxy cluster
      • Take over an OBProxy
      • Delete an OBProxy
      • Restart an OBProxy
      • Upgrade an OBProxy
      • Add an OBProxy
      • Refresh OBProxy configurations
      • Monitor OBProxy cluster performance
      • OBProxy cluster parameter management
      • Add a connectable OceanBase cluster
      • Delete an OBProxy cluster
      • Upgrade all OBProxies in an OBProxy cluster
      • Restart all OBProxies in an OBProxy cluster
      • Delete a connected OceanBase cluster
    • Use backup and recovery
      • Backup and recovery management operations
      • Backup and recovery guide
      • Create a backup strategy
      • Back up now
      • Create a sampling strategy for recovery
      • Initiate a recovery task
      • Install a service
      • Add a node
      • Upgrade the version of a service
      • Update service configurations
      • Copy a service
      • Delete a service
      • Stop a service on a node
      • Restart a service on a node
      • View O\&M tasks
      • Uninstall a service on a node
    • Manage alerts
      • Alert-related concepts
      • Create an alert item
      • View alert items
      • Copy an alert item
      • Edit an alert item
      • Delete an alert item
      • Alert groups
      • Create an alert channel
      • View alert channels
      • Edit an alert channel
      • Delete an alert channel
      • View alert events
      • View the alert notification history
      • Create a blocking condition
      • Edit a blocking condition
      • Delete a blocking condition
      • Add a filtering keyword
      • Modify the expiration time of a filter keyword
      • Delete a filter keyword
      • Create an alert subscription
      • Manage alert subscriptions
    • Use system management
      • Role overview
      • Create a role
      • Manage roles
      • Copy a role
      • Create a user
      • View users
      • Edit a user
      • Copy a user
      • Change a user password
      • Delete a user
      • Logon history
      • Manage system parameters
      • Log service
        • Query logs
        • Configure trace query parameters
        • Trace query
      • Manage tasks
      • Use the inspection feature
        • Initiate an inspection
        • Create an inspection rule
        • Modify an inspection rule
        • Delete an inspection rule
        • View inspection rules
        • View an inspection task
        • View an inspection report
        • Download an inspection report
        • View an inspection item
    • User center management
      • Create a connection
      • Export connection credentials
      • Import connection credentials
      • Share connection credentials
      • Edit connection credentials
      • Delete connection credentials
      • Batch operations on connection credentials
      • Accept a connection
      • Ignore a connection
    • Manage OCP clusters in the multi-cluster mode
      • Register an OCP cluster
      • Leader \& Follower Details
      • Manage OCP cluster parameters
      • Switch an OCP cluster in daily maintenance
      • Switch an OCP cluster in a failover
      • Delete a faulty follower OCP cluster
      • Unbind a leader and a follower OCP cluster
    • Manage OCP in multi-zone mode
      • View details of multiple zones
      • Manage parameters in multi-zone mode
    • Appendix
      • OCP configuration parameters
      • SQL performance module
      • OCP resource unit specifications
      • OCP error codes
      • OCP alert template variables
      • Call an alert API
      • OCP background tasks
      • Monitoring metrics
      • Examples of alert channel configuration
      • OBProxy startup parameters
      • System privileges in a MySQL tenant
      • Component listening port list
      • OCP-Agent processes
      • Enable the OCP multi-cluster mode
      • PAM permission denied
      • Failed to upload the software package
      • Check the sudo permissions of a user
      • Default OCP roles
      • FAQ about multi-zone mode
      • FAQ about OBProxy takeover
      • Diagnose XA transactions and suspended transactions
      • About OpenSearch
  • Metric reference
    • Overview of metrics
    • OceanBase cluster
      • QPS
      • Query response time
      • TPS
      • Transaction response time
      • Request queue time
      • Number of sessions
      • TPS
      • Number of transaction logs
      • Transaction log volume
      • Time consumed by transaction logs
      • IOPS
      • Time consumed by I/O operations
      • I/O throughput
    • OceanBase Database tenant
      • QPS
      • Response time
      • Sessions
      • SQL execution plan types
      • Wait events
      • Time consumed by waiting events
      • Request queue
      • Request queue time
      • CPU utilization
      • MemStore usage
      • Time consumed by RPC packets
      • RPC packet throughput
      • Memory usage
      • opened_cursors
      • Clog synchronization delay
      • TPS
      • Transaction response time
      • Number of transaction logs
      • Transaction log volume
      • Time consumed by transaction logs
      • Lock waits
      • Time consumed by lock waits
      • TPS
      • MemStore
      • IOPS
      • Time consumed by I/O operations
      • I/O throughput
      • Cache size
      • Cache hit rates
      • Number of cache requests
    • OBProxy cluster
      • TPS
      • Requests per second
      • Client connections
      • Server connections
      • Average response time for each SQL statement
      • Average route table queries per second
      • Average bytes in a network request or response
    • Host
      • Linux system load
      • CPU Utilization
      • IOPS
      • Time consumed by I/O operations
      • I/O throughput
      • Network throughput
      • Memory
      • Disk
  • Troubleshooting
    • Failed to register a follower OCP cluster
    • Failed to add credentials to the password box
    • Restricted OCP logon
    • Failed to view logs in OCP
    • Failed to upload the software package
    • Do IO Bench error
    • Check the sudo permissions of a user
    • PAM permission denied
    • Resolve the problem of no sudo permissions when adding a host
    • Questions about OCP-Agent
      • Exceptions of the ocp_agent processes
      • System resource constraints and PAM
    • Appendix
      • Processes
      • OCP-Agent O&M tool
  • Alert Reference
    • Alert Reference
    • OceanBase alerts
      • ob_cannot_connected
      • ob_cluster_rs_not_same
      • ob_cluster_status_check_failed
      • ob_cluster_exists_inactive_server
      • ob_cluster_exists_index_fail_table
      • ob_cluster_frozen_version_delta_over_threshold
      • ob_cluster_merge_error
      • ob_cluster_merge_timeout
      • ob_cluster_no_frozen
      • ob_cluster_no_merge
      • ob_cluster_operation_info
      • ob_cluster_sync_failed
      • ob_cpu_assigned_percent_over_threshold
      • ob_cpu_percent_over_threshold
      • ob_host_connection_percent_over_threshold
      • ob_host_disk_readonly
      • ob_tenant_expired_trans_exist
      • ob_host_load1_per_cpu_over_threshold
      • ob_host_partition_count_over_threshold
      • ob_log_alarm
      • ob_mem_assigned_percent_over_threshold
      • ob_server_sstable_percent_over_threshold
      • ob_tenant_long_trans_exist
      • ob_tenant_operation_info
      • ob_tenant500_mem_hold_over_threshold
      • ob_tenant500_mem_hold_percent_over_threshold
      • ob_zone_sstable_percent_over_threshold
      • tenant_active_memstore_percent_over_threshold
      • tenant_cpu_percent_over_threshold
      • tenant_memstore_percent_over_threshold
      • obproxy_process_dead
      • obproxyd_process_dead
      • obproxy_cannot_connected
      • ob_cluster_sync_delay_time_too_long
      • ob_host_data_disk_percent_over_threshold
      • ob_host_log_disk_percent_over_threshold
      • ob_host_install_disk_percent_over_threshold
      • ob_tenant_exists_expired_xa_trans
      • ob_cluster_active_session_count_over_threshold
      • ob_tenant_active_session_count_over_threshold
      • ob_host_active_session_count_over_threshold
      • ob_tenant_slow_sql_exists
      • ob_tenant_large_trans_exist
      • same_alarm_rule_detect_too_many_targets
      • ob_tenant_expired_trans_exist
      • ****# ob_tenant_long_trans_exist
      • ob_tenant_task_timeout
      • ob_host_task_timeout
      • ob_tenant_log_disk_usage_high
      • ob_tenant_no_compaction
      • ob_tenant_no_frozen
      • ob_tenant_compaction_error
    • Application alerts
      • ob_cluster_inspection_not_passed
      • ob_host_ssd_wear_indicator_over_threshold
      • ob_host_mem_percent_over_threshold
      • ob_host_net_recv_percent_over_threshold
      • ob_host_net_send_percent_over_threshold
      • ob_host_tcp_retrans_percent_over_threshold
      • ob_host_cpu_percent_over_threshold
      • no_enough_exporter
      • inc_backup_delay
      • base_backup_fail
      • base_backup_too_long_time_no_one_success_task
      • backup_process_dead
      • backup_storage_capacity_over_threshold
      • backup_storage_capacity_retry_times_exceeded
      • backup_storage_capacity_timeout_or_interrupted
      • ocp_remote_server_time_diff_too_large
      • monitor_exporter_unavaliable
      • system_obproxy_unavailable
      • host_unavailable
      • host_ntp_offset_too_large
      • host_ntp_service_not_exist
      • host_agent_res_memory_over_threshold
      • host_agent_open_fd_count_over_threshold
      • host_agent_goroutine_count_over_threshold
      • partition_create_failed
      • obagent_dead
      • host_disk_readonly
      • ic_server_connect_failed Inter-Connector
      • vpc_connect_failed
      • node_load1_peak
    • OAS alerts
      • os_cpu_irq_error
      • os_tsar_cpu_sys_abnormal
      • os_observer_fd_usage
      • os_tsar_cpu_util_full
      • os_tsar_cpu_util_hwm
      • os_kernel_io_hang
      • os_tsar_sda_ioawait
      • os_tsar_nvme_ioawait
      • os_tsar_traffic_drop
      • os_tsar_traffic_error
      • os_observer_not_exist
      • os_observer_core_dump
      • os_nic_1000m_full
      • os_nic_1000m_hwm
      • os_tsar_traffic_overload
      • node_file_root_usage
      • node_file_inode_usage
      • os_kernel_ntp_down
      • os_kernel_ntp_delay
      • node_memory_peak
      • os_home_file_usage
      • node_file_data1_usage
      • node_file_datalog1_usage
    • Appendix
      • Set an alert-blocking condition
      • Modify alert thresholds
      • Exception handling for OceanBase cluster compaction
      • OCP-Agent script
      • Apply throttling to an OceanBase cluster
      • Network troubleshooting
      • Tables managed by the daemon
      • Examples of alert channel configuration
  • API Reference
    • Overview
    • API call description
    • Cluster information
      • Query clusters
      • Create an OceanBase cluster
      • Delete an OceanBase cluster
      • Stop an OceanBase cluster
      • Start an OceanBase cluster
      • Restart an OceanBase cluster
      • Upgrade an OceanBase cluster
      • Query zones of an OceanBase cluster
      • Create a zone for an OceanBase cluster
      • Delete a zone from an OceanBase cluster
      • Stop a zone in an OceanBase cluster
      • Start a zone in an OceanBase cluster
      • Restart a zone in an OceanBase cluster
      • Add an OBServer
      • Delete multiple OBServers at a time
      • Stop an OBServer
      • Start an OBServer
      • Restart an OBServer
      • Replace an OBServer
      • Change the password of an OceanBase cluster
      • Query the parameter metadata of an OceanBase cluster
      • Query parameters of an OceanBase cluster
      • Modify parameters of an OceanBase cluster
      • Query servers
      • Query servers in a zone
    • Tenant information
      • Query tenants of a cluster
      • Query all tenants
      • Query details about a tenant
      • Create a tenant
      • Create a tenant
      • Delete a tenant
      • Lock a tenant
      • Unlock a tenant
      • Query units of a tenant
      • Delete a unit from a tenant
      • Add a replica for a tenant
      • Delete a replica of a tenant
      • Modify a replica of a tenant
      • Modify zone priorities of a tenant
      • Change the administrator password of a tenant
      • Modify the whitelist of a tenant
      • Query parameters of a tenant
      • Modify parameters of a tenant
      • OceanBase database management
        • Query databases
        • Create a database
        • Modify a database
        • Delete a database
    • Hosts
      • Query regions
      • Query details about a region
      • Add a region
      • Delete a region
      • Query IDCs
      • Query details about an IDC
      • Add an IDC
      • Delete an IDC
      • Query host types
      • Query details about a host type
      • Add a host type
      • Delete a host type
      • Query hosts
      • Query details about a host
      • Add multiple hosts at a time
      • Delete a host
      • Delete multiple hosts at a time
    • Software packages
      • Query software packages
      • Upload a software package
      • Delete a software package
    • OBProxy management
      • Create an OBProxy cluster
      • Delete an OBProxy cluster
      • Query OBProxy clusters
      • Query details about an OBProxy cluster
      • Update configurations of an OBProxy cluster
      • Add an OBProxy
      • Take over an OBProxy
      • Delete an OBProxy
      • Restart an OBProxy
      • Upgrade an OBProxy
      • Add a connectable OceanBase cluster for an OBProxy cluster
      • Remove a connectable OceanBase cluster from an OBProxy cluster
      • Query the parameter metadata of an OBProxy
      • Query parameters of an OBProxy cluster
    • Monitoring
      • Query the metadata of a monitoring metric
      • Query monitoring data
      • Query monitoring data and attach a tag to the data
    • Alerts
      • Alert events
        • Query the alert event list
        • Query alert events
      • Alert notifications
        • Query alert notifications
    • Task management
      • Query tasks
      • Query details about a task
      • Retry a task
      • Roll back a task
      • Query logs of a subtask instance
      • Retry a subtask
      • Skip a subtask
      • Cancel a subtask
    • OCP event history
      • Query event history
    • OceanBase user and privilege management
      • Query database user details
      • Query database user details
      • Create a database user
      • Delete a database user
      • Change the password of a database user
      • Lock a database user
      • Unlock a database user
      • Query the database role details
      • Query database role details
      • Create a database role
      • Delete a database role
      • Query database objects
      • Grant global privileges to a user
      • Revoke global privileges of a user
      • Change global privileges of a user
      • Grant global privileges to a role
      • Revoke global privileges of a role
      • Change global privileges of a role
      • Grant roles to a user
      • Revoke roles of a user
      • Change roles of a user
      • Grant roles to a role
      • Revoke roles of a role
      • Change roles of a role
      • Grant database privileges to a user
      • Revoke database privileges of a user
      • Change database privileges of a user
      • Grant object privileges to a user
      • Revoke object privileges of a user
      • Change object privileges of a user
      • Grant object privileges to a role
      • Revoke object privileges of a role
      • Change object privileges of a role
    • OCP Agent management
      • Query OCP Agent details on a host
      • Stop basic OCP Agent processes on a host
      • Batch stop basic OCP Agent processes on a host
      • Restart basic OCP Agent processes on a host
      • Batch restart basic OCP Agent processes on a host
      • Query OCP Agent processes on a host
      • Restart OCP Agent processes on a host
      • Stop OCP Agent processes on a host
    • SQL performance
      • Query performance indicators of an SQL statement
      • Query the performance indicator trend of an SQL statement
      • Query SQL text
      • Query performance indicators of an execution plan
      • Query the performance indicator trend of an execution plan
      • Query the operator structure of an execution plan
    • Backup and recovery
      • Query backup capabilities of a cluster
      • Create a backup strategy for a cluster
      • Modify the backup strategy of a cluster
      • Delete the backup strategy of a cluster
      • Query the backup strategy of a cluster
      • Query the backup overview of a cluster
      • Query data backup tasks of a cluster
      • Query log backup tasks of a cluster
      • Query recovery tasks of a cluster
      • Immediately back up a cluster
      • Parse cluster backup data
      • Initiate tenant recovery
    • Others
      • Query the basic information of an OCP application
      • Query OCP server time
      • Query OCP application status
    • Appendix
      • Task information
      • View alerts through APIs
  • FAQ
    • FAQ on deployment
    • FAQ on upgrade
    • FAQ on monitoring
      • FAQ on monitoring metrics
      • FAQ on SQL monitoring
      • FAQ about resource usage
      • Use OCP-Agent to push time-series monitoring data
    • FAQ on alerts
    • FAQ on O&M
      • FAQ on accounts and passwords
      • FAQ on host management
      • FAQ on OceanBase cluster
      • FAQ on OceanBase tenants
      • FAQ on OBProxy
      • FAQ on the OCP software package
      • FAQ on backup and recovery
    • FAQ on the OCP system
    • OCP multi-cluster FAQ

Download PDF

Document Overview What is OceanBase Cloud Platform? System architecture Features System requirements Dependencies What is OceanBase Cloud Platform? System architecture Overview Deploy OCP on a single node Deploy OCP clusters in the multi-cluster mode OCP-Server specifications MetaDB resources MonitorDB resources Host resources Standardize a host Check the environment Prepare installation media Generate a configuration file Multi-zone deployment Deploy OCP Register an OCP cluster Initialize system parameters Check after deployment Optimize MonitorDB parameters Ubuntu deployment FAQ EulerOS deployment FAQ Client requirements Start and stop OCP OCP operations Upload a software package Add a host Create a cluster Create a tenant Create a user Create an OBProxy clusterOCP overview Log on to the OCP console Packages Cluster management operations View the topology of a cluster Overview of cluster tenant managementPerformance monitoring Performance reportCluster backup and recovery Manage cluster parameter templates Tenant management operations View the topology of a tenantDatabase management User management under a MySQL tenant Performance monitoring Tenant resource management Transaction diagnostics Back up and recover a tenant Manage tenant parameter templatesHost management operations Add a host Modify a host Restart OCP Agent Reinstall OCP Agent Host monitoring Upload a software package Download a software package Delete a software package Create an OBProxy clusterTake over an OBProxyDelete an OBProxy Restart an OBProxy Upgrade an OBProxy Add an OBProxyRefresh OBProxy configurations Monitor OBProxy cluster performance OBProxy cluster parameter managementAdd a connectable OceanBase clusterDelete an OBProxy cluster Upgrade all OBProxies in an OBProxy cluster Restart all OBProxies in an OBProxy cluster Delete a connected OceanBase cluster Backup and recovery management operations Backup and recovery guide Create a backup strategyBack up now Create a sampling strategy for recoveryInitiate a recovery taskInstall a service Add a node Upgrade the version of a serviceUpdate service configurations Copy a service Delete a service Stop a service on a node Restart a service on a node View O\&M tasks Uninstall a service on a node Alert-related concepts Create an alert item View alert items Copy an alert item Edit an alert item Delete an alert item
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Cloud Platform
  3. V4.0.0
iconOceanBase Cloud Platform
V 4.0.0Enterprise Edition
  • V 4.3.6
  • V 4.3.5
  • V 4.3.4
  • V 4.3.3
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.2
  • V 4.0.0 and earlier
Community Edition
  • V 4.0.0
  • V 3.1.1
Enterprise Edition
  • V 4.0.0
  • V 3.3.1

FAQ on OceanBase cluster

Last Updated:2023-08-15 02:30:55  Updated
share
What is on this page
Questions about feature implementation
Questions about OceanBase cluster management
Questions about OceanBase cluster deployment
Questions about OceanBase cluster takeover
Questions about OceanBase cluster upgrade
Questions about OceanBase cluster monitoring
Questions about cluster inspection

folded

share

This topic provides answers to the frequently asked questions about OceanBase cluster management.

Questions about feature implementation

Q1: Can I use an x86 OCP system to manage an OceanBase cluster in the Arm architecture ?

A: You can do so in OCP V2.5.2 or later.

Q2: Which version of OCP can I use to deploy an OceanBase V1.4.79 cluster ?

A: You can deploy such a cluster by using OCP of any version. We recommend that you use the latest version of OCP.

Q3: Does OCP support a deployment plan of using the x86 architecture for the primary OceanBase cluster and the Arm architecture for standby OceanBase clusters ?

A: Such a deployment plan is supported in OCP V3.1.0 and later.

Questions about OceanBase cluster management

Q1: Where can I view the delay between the primary and standby clusters?

A: Click Cluster Overview, switch to the topology of the cluster, and then view the delay between the primary and standby clusters.

Q2: What should I do when I receive the error message machine resource is not enough to hold a new unit?

A: If the server resources are insufficient, replica migration tasks cannot proceed. You can add hosts to solve this issue.

Q3: What is the strategy used by OCP-Agent in automatically clearing observer.log?

A: When the memory usage reaches 80%, the latest 100 log records are retained and the earlier ones are automatically cleared.

Q4: How can I obtain the topology status of a cluster?

A: You can obtain the topology status of a cluster based on the records in the ob_server table of MetaDB.

Q5: Where can I get the total number of sessions of OCP?

A: You can get the number from the internal table __all_virtual_processlist of OceanBase Database.

Q6: What is an inactive session? How are inactive sessions managed?

A: If a session remains idle for a specified period after it is created, the session is changed to the inactive state. By default, a session is marked as inactive after it remains idle for 28,800s. Inactive sessions are released by the client that has a timeout mechanism. OceanBase Database will not proactively release inactive sessions.

Q7: Does an inactive session occupy the maximum number of connections supported by a unit?

A: The actual distribution of connections is not affected by the maximum unit connections. Instead, it is affected by the maximum OBServer connections. Unit connections are used as an alert condition in OCP.

Q8: Which ports do I need to enable if OCP and OceanBase Database are deployed in different CIDR blocks ?

A: For more information, see Component listening port list.

Q9: How do I quickly delete a cluster with failed tasks?

A: Change the status of the cluster from Operating to NORMAL in the ob_cluster table of MetaDB. Then, you can delete the cluster.

Q10: In the health inspection result description of the OceanBase cluster, the following message appears: Replicas: unknown > 100000, Critical. What does it mean?

A: unknown indicates that the system failed to get the number of partitions. We recommend that you perform the following steps to locate the fault:

  1. Check whether related data is displayed in the Capacity_Number of Partitions diagram on the Tenant Management page in the OceanBase cluster. No data is displayed.

  2. Check whether the processes in the Processes list of the corresponding host are normal. The obstat and logtailer processes stop abnormally.

  3. Check whether the DNS is incorrectly resolved, causing the host to fail to access the database and the obstat and logtailer processes to fail to start.

We recommend that you configure the DNS address in the /etc/resolve.conf file of the host that returns the error, and check whether the problem persists.

Q11: Why am I unable to delete a cluster or quit the deletion task in OCP ?

A: If you delete a host in the OBServer cluster by using a CLI tool, the host is abnormally offline and the cluster information in MetaDB is inconsistent with that of the OceanBase cluster. We recommend that you do not delete an OceanBase cluster forcibly if some OBServers in the cluster are offline. We recommend that you contact a technical engineer to manually modify the related data in MetaDB.

Questions about OceanBase cluster deployment

Q1: An error occurred when I was creating a cluster. Error message: illegal argument exception. What should I do?

A: Check whether the name of the RPM package is duplicated.

Q2: An error occurred at the Confirm Information step when I was installing OceanBase Database. Error message: An unknown error has occurred. Cause: {0}. Error message: {1}. Contact the administrator. What is the cause of this problem?

A: Check whether the name of the OceanBase Database software package is modified.

A3: The architecture of my primary cluster is x86. I plan to add AArch64 hosts into the standby cluster. Can I use the x86 software package to deploy standby clusters?

A: This deployment plan is risky. We recommend that you use servers of the same architecture for both the primary and standby clusters.

Q4: Why does the system report invalid zone priority when I use OCP to create a cluster ?

A: The region of the top priority zone must have at least two zones.

Q5: When I create a standby cluster in OCP, is it true that the primary/standby data synchronization task is implemented and ends together with the cluster creation task?

A: The standby cluster creation task has nothing to do with the primary/standby synchronization task. The standby database provides services to applications only after it is created.

Q6: I used OCP V2.5.x to create primary and standby clusters, and I set the primary_zone of both the tenant and table to RANDOM. Why does the system report Add cluster not allowed and display the prompt CHECK PRIMARY ZONE OR LOCALITY CONFIG when I run a task?

A: The primary_zone or locality is configured in a table. Perform the following steps to solve the problem:

  1. Check for the table in which primary_zone or locality is configured in the OceanBase database of the SYS tenant.

    select table_id,tenant_id,primary_zone,locality,table_name from __all_virtual_table;
    

    The table in which primary_zone or locality is configured is named t, and the tenant ID is 1001.

  2. Execute the alter table t set primary_zone = default; statement in the database of the corresponding tenant to cancel the primary_zone setting of the table.

  3. Execute the following statements in the database of the corresponding tenant to cancel the locality setting of the table:

    select locality from __all_tenant where tenant_id = 1001;     # The query result is F@zone1,F@zone2,F@zone3.
    alter table t set locality = 'F@zone1,F@zone2,F@zone3';
    

Q7: I have an OCP system that manages an OceanBase cluster in a private cloud. I want to deploy a new OCP system in the same environment and create an OceanBase V2.2.7x cluster in it. I have changed the default value of cluster_id in the /root/t-oceanbase-antman/obcluster.conf file to 100000 when I deploy OCP. What else do I need to modify when I create the OceanBase cluster?

A: When you use OCP to create an OceanBase cluster, you must ensure that the cluster ID and cluster name are unique.

Questions about OceanBase cluster takeover

Q1: An error occurred on the host when I was adding a server to the cluster. Error message: Python dependency does not exist. What should I do?

A: The host was not installed using the installation template. Manually install the Python script. We recommend that you install the host using the installation template.

Q2: An error occurred when I was using OCP V2.5.x to take over an OceanBase cluster. Error code: 11042. Precheck of the cluster to be taken over failed. Cause: OBServer check failed. What should I do?

A: We recommend that you call the precheck API to find the cause of the OBServer check failure. Execute the following statement to call the API:

curl -X POST --user admin:xxx \
  -H "Content-Type:application/json" \
  -d '{"rootSysPassword":"xxxxx",                   # Required. The password of the root@sys account.
         "address":"xxxxx",                                 # Required. The address used to connect to the cluster.
         "port":2888,                                           # Required. The port used to connect to the cluster.
         "connectionMode": "proxy"                  # Optional. The connection mode. Valid values: direct and proxy. Default value: direct.
         "clusterName": "xxx",                            # Optional in most cases. If the connection mode is set to proxy, it is required.
         "obClusterId": xxx                                 # Optional in most cases. When the connection mode is set to proxy and the cluster to be taken over is a standby cluster, it is required.
        }' \
  "http://example.com:8080/api/v2/ob/clusters/takeOverPreCheck"

Q4: What should I pay attention to when I take over an OceanBase cluster from another OCP?

A: Pay attention to the following when you take over an OceanBase cluster from another OCP:

  • Confirm the way that businesses access the OceanBase cluster so as to confirm the impact of the takeover on businesses.

  • Migrate the cluster from its original OCP, or stop this OCP.

  • In a single-OCP scenario, the primary OceanBase cluster is taken over before the standby OceanBase cluster.

  • In a multi-OCP scenario, the primary OceanBase cluster is taken over in any OCP before the standby OceanBase cluster is taken over in any OCP.

Questions about OceanBase cluster upgrade

Q1: How do I upgrade the primary and standby clusters?

A: You can click the Upgrade Version button in the upper-right corner of the Overview page of the primary and standby clusters to upgrade them. The upgrade applies to both the primary and standby clusters, regardless of whether you click the Upgrade Version button on the Overview page of the primary or standby cluster.

Q2: The connection timed out when I was refreshing schema information to upgrade my OceanBase cluster in OCP. What should I do?

A: Run the following command to view the schema and version:

select tenant_id, refreshed_schema_version from __all_virtual_server_schema_info " + " where svr_ip = '%s' and svr_port = %d and refreshed_schema_version >
select max(value) value from oceanbase.__all_virtual_sys_parameter_stat where name = 'min_observer_version'

If the schema and version are correct, manually retry CheckRefreshSchemaTask.

Q3: Why does the system report "execute upgrade checker" when I upgrade the OceanBase cluster?

A: The RPM package download may have timed out. We recommend that you try to upgrade the cluster again.

Q4: Why does the system report No node of the corresponding version when I try to upgrade OceanBase Database from V2.2.71 to V2.2.74?

A: The upgrade path defined in the /home/admin/ocp-server/etc/oceanbase_upgrade_dep.yml file on the OCP server is incomplete. We recommend that you add the following version information to OceanBase Database V2.2.74:

# Previous content is omitted.
- version: 2.2.70
  can_be_upgraded_to:
      - 2.2.71
- version: 2.2.71
  can_be_upgraded_to:
      - 2.2.72
- version: 2.2.72
  can_be_upgraded_to:
      - 2.2.73
- version: 2.2.73         # The last version must be defined. Otherwise, the upgrade path is unavailable for same version upgrade.
  can_be_upgraded_to:
      - 2.2.74

Q5: What does it mean to say Replace Binary Files on the Confirm Upgrade Path page of the OceanBase cluster ?

A: It means to replace the binary file of the OBServer. In OceanBase Database V2.2.72 and V2.2.73, you only need to run the pre/post script without replacing the binary file of the OBServer. The message is informational and does not require manual operations. The binary file will be automatically replaced during an upgrade.

Q6 : An error is reported when I upgrade an OceanBase cluster. Error message: [alter system stop zone ?]; SQL state [25000]; error code [4012]; Statement is timeout. What should I do?

A: We recommend that you try again.

Q7: Why do I fail to upgrade an OceanBase cluster from V2.2.30 to V2.2.50 ?

A: You have not uploaded the V2.2.40 RPM package that is required for OceanBase upgrades. We recommend that you upload the package and try to upgrade the cluster again.

Q8: I want to upgrade the minor version before I upgrade the major version. Does OCP support upgrading to the same version ?

A: Yes, OCP supports upgrading to the same major version. However, the minor versions must be different.

Q9: I use OCP to upgrade the OceanBase cluster. Why does a server fail and report Cannot allocate memory at the Install rpm step?

A: The memory is insufficient. We recommend that you clear the content in the memory or increase the memory as needed.

Q10: When I upgrade an OceanBase cluster, the upgrade_checker.py script reports an error. Error message: MyError: "(1, Decimal('1.0000')) check_logonly_replica_unit failed, not found log_type resource_pool for this tenant. Why?

A: Check for log replicas of the OceanBase cluster to be upgraded. If any, we recommend that you replace the log replicas with full-featured replicas.

Q11: If an OceanBase cluster includes the omsmeta and odpmeta tenants in addition to the SYS, ocp-meta, and ocp-monitor tenants, how can I upgrade the cluster?

A: You can contact OceanBase Technical Support to obtain the corresponding upgrade document to upgrade the cluster. The operation will not affect the tenants of other applications.

Questions about OceanBase cluster monitoring

Q1: When I use OCP to create a cluster, can the ocp_monitor user be automatically created? If yes, what is the default password of this user?

A: Yes, the ocp_monitor user is automatically created. You do not need to know the password of this user. After the ocp_monitor user is created, the password of this user is used by the system when the system calls this user.

Q2: Does transaction log time on the Performance Monitoring page refer to the average time consumed by SQL statements or the average time consumed by transactions ?

A: It refers to the average time consumed by transactions.

Questions about cluster inspection

Q1: The maximum usage of the /data/1 data disk in OBServer is 90% of the disk storage of the host, and the disk usage threshold of the host in health inspection of the cluster is set to 85%. Is the setting appropriate ?

A: During health inspection, the data disk of OceanBase Database will be ignored.

Previous topic

FAQ on host management
Last

Next topic

FAQ on OceanBase tenants
Next
What is on this page
Questions about feature implementation
Questions about OceanBase cluster management
Questions about OceanBase cluster deployment
Questions about OceanBase cluster takeover
Questions about OceanBase cluster upgrade
Questions about OceanBase cluster monitoring
Questions about cluster inspection