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 Cloud

OceanBase Database

Tools Connectors and Middleware

QUICK START

OceanBase Cloud OceanBase 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

OceanBase Cloud Platform

V4.2.2

Document Overview
Product Introduction
- What is OceanBase Cloud Platform?
- Differences between the features of OCP Enterprise Edition and OCP Community Edition
- System architecture
- Features
- Limits
  - System requirements
  - Dependencies
Deploy OceanBase Cloud Platform (OCP)
- Deploy OceanBase Cloud Platform (OCP) Enterprise Edition
  - Deployment overview
    - Deploy OCP cluster in the Single-node
    - Deploy OCP cluster in the High-availability
  - Prepare the deployment environment
    - Install OAT
    - Add a server
    - Check the environment
  - Deploy OCP
    - Plan resources
      - Planning resources of a single node OCP
        OCP-Server specifications
        MetaDB resources
        MonitorDB resources
        Host resources
      - Planning resources of a high availability OCP
        OCP-Server specifications
        MetaDB resources
        MonitorDB resources
        Host resources
    - Deploy OCP
      - Deploying a single point of OCP
        Prepare installation media
        Create MetaDB
        Install OCP
        Initialize system parameters
      - Deploying a high availability of OCP
        Prepare installation media
        Create MetaDB
        Install 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
  - Appendix
    - Uninstall OCP
- Deploy OceanBase Cloud Platform (OCP) Community Edition
  - Overview
  - Installation process
  - Installation planning
    - User planning
    - Host planning
    - Disk and directory planning
    - Port planning
  - Prepare for the installation
  - Deploy OCP on the GUI
  - Use Docker to deploy OCP
  - Post-deployment check
  - Appendix
    - Install Docker
    - Uninstall OCP
    - Restart OCP
    - FAQ about deployment
Upgrade OceanBase Cloud Platform (OCP)
- Upgrade OceanBase Cloud Platform (OCP) Enterprise Edition
  - Overview
  - Considerations
  - Preparations
  - Upgrade OCP
    - Take over OCP
    - Upgrade OCP
  - Verify after upgrade
    - Verify the cluster feature
    - Verify the tenant feature
    - Verify the host feature
    - Verify the software package feature
    - Verify the OBProxy feature
    - Verify the backup and restore feature
    - Verify the alert feature
    - Verify the task feature
    - Verify the password box feature
  - Appendix
    - Change a user's password
    - Version mapping
- Upgrade OceanBase Cloud Platform (OCP) Community Edition
  - Upgrade OCP on the GUI
  - Upgrade OCP using Docker containers
  - Post-upgrade check
Quick Start
- OCP operations
- Log on to the OCP console
- Upload a software package
- Add a host
- Create a cluster
- Create a tenant
- Create a user
- Create an OBProxy cluster
Cluster Management
- Overview
- Create a cluster
  - Create a distributed cluster
  - Create a standalone centralized database
- Manage clusters
  - Create a standby cluster
  - View the details of a cluster
  - Upgrade a standalone centralized database to a distributed cluster
  - Take over a cluster
  - Restart a cluster
  - Stop a cluster
  - Migrate a cluster
  - Delete a cluster
  - Change the password
  - Enable automatic detection of deadlocks
  - Disable automatic detection of deadlocks
  - Disable SQL collection
  - View the SQL collection history
- Manage Arbitration Service
  - Arbitration service Overview
  - Create an arbitration service
  - Take over an arbitration service
  - Stop an arbitration service
  - Start an arbitration service
  - Upgrade an arbitration service
  - Restart an arbitration service
  - Migrate an arbitration service
  - Delete an arbitration service
  - Add an arbitration service
  - Replace an arbitration service
  - Remove an arbitration service
- Manage zones of a cluster
  - Add a zone
  - Restart a zone
  - Stop a zone
  - Delete a zone
- Manage OBServers of a cluster
  - Add an OBServer node
  - Restart a faulty OBServer node
  - Stop an OBServer service
  - Stop the observer process
  - Replace an OBServer node
  - Reinstall an OBServer
  - Delete an OBServer
- Upgrade an OceanBase cluster
- View the topology of a cluster
- Overview of cluster tenant management
- Manage cluster resource
  - View the unit distribution
  - View resource usage
- Manage major compaction of a cluster
  - Modify the major compaction settings of a cluster
  - Perform a major compaction
  - View details of major compaction
  - View major freeze statistics
- Manage cluster parameter templates
- Manage cluster parameters
  - Parameter types
  - View parameters
  - Modify parameters
  - View the history of parameter changes
Tenant Management
- Tenant and resource management
- View cluster overview information
- Create a primary tenant
- Manage unit specifications
- View OCP resource unit specifications
- Manage tenants
  - Overview of the Tenant Details page
  - Create a standby tenant
  - Copy a tenant
  - Lock a tenant
  - Delete a tenant
  - Change the password of the sys tenant
  - Configure full link tracking for a tenant
- Modify the allowlist of a tenant
- Modify zone priorities
- Manage topulogy of a tenant
  - View the topology of a tenant
  - View the topology of primary/standby relationships of a tenant
- Manage replicas of a tenant
  - Add a replica
  - Edit a tenant replica in a zone
  - Delete a tenant replica from a zone
- Manage databases
- Manage users and permissions under a tenant
  - Manage users in a MySQL tenant
  - Manage user 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
  - System privileges in a MySQL tenant
- Manage resource isolation
  - Overview
  - Create a resource group
  - Create a resource isolation plan
  - Enable or disable a resource isolation plan
  - Modify a resource isolation plan
  - Delete a resource isolation plan
  - Modify a resource group
  - Delete a resource group
- Manage the resources of a tenant
- Manage major compaction under a tenant
  - Modify major compaction settings of a tenant
  - Details of tenant major compaction
  - Perform a major compaction
- Manage tenant parameter templates
- Manage tenant parameters
  - View the parameters
  - Modify a parameter
  - View the parameter modification history
OBProxy Management
- OBProxy management overview
- View details on the OBProxy page
- Create an OBProxy cluster
- Manage OBProxy Clusters
  - View details on the Overview page of an OBProxy cluster
  - Add a connectable OceanBase cluster
  - Manage load balancing
  - Change the password of the proxysys user
  - Change the password of the proxyro user
  - Migrate an OBProxy cluster
  - Delete an ODP cluster
  - Upgrade an OBProxy cluster
  - Stop or start an ODP cluster
  - Restart an ODP cluster
  - Delete a connected OceanBase cluster
  - Manage the proxyro account
- Manage OBProxy Servers
  - Add an OBProxy
  - Take over an OBProxy
  - Delete an OBProxy
  - Restart an OBProxy
  - Stop or start an OBProxy
  - Remove an OBProxy
  - Launch an OBProxy
  - Upgrade an OBProxy
  - Refresh OBProxy configurations
- Request analysis
- Parameter management
- Client configuration
- OBProxy parameters descpription
Host Management
- Host management operations
- View details of a host
- Add a host
- View the details of tasks on a host
- Modify a host
- Restart OCP-Agent
- Reinstall OCP Agent
- Remove a host
- Perform host standardization checks
- Host standardization check items
- OCP-Agent processes
- OCP-Agent O&M Script Instructions
Alert Management
- Overview
- Alert-related concepts
- Manage alert rules
  - Create an alert rule
  - View an alert rule
  - Copy an alert rule
  - Edit an alert rule
  - Delete an alert rule
  - Alert rule groups
  - Export alert rule configurations
- Manage alert templates
  - Create an alert template
  - Set alert objects
  - Export alert templates
  - View an alert template
  - Copy an alert template
  - Edit an alert template
  - Delete an alert template
- Manage alert channels
  - Create an alert channel
  - View an alert channel
  - Edit an alert channel
  - Copy an alert channel
  - Delete an alert channel
  - Examples of alert channel configuration
  - Examples of alert channel configuration
- Manage alert push
  - Create an alert push
  - View an alert push
  - Edit an alert push
  - Delete an alert push
- View alert events
- Manage blocking conditions
  - Create a blocking condition
  - Edit an alert blocking condition
  - Delete an alert blocking condition
- OCP alert template tag
- Optional monitoring metrics for custom alerts
Dashboard Management
- Monitoring dashboard overview
- Manage dashboards
- Manage groups
- Manage charts
Performance Monitoring
- Manage monitoring
  - OCP Overview
  - View database performance
  - View host performance
  - View the performance and SQL monitoring data of a tenant
  - View transaction performance data
  - View storage and cache monitoring data
  - View host resources
  - View host processes
  - View service monitoring data
  - View system monitoring data
  - View performance monitoring
  - Drill-down monitoring
- Use the custom monitoring feature
  - Overview
  - View collection items
  - Manage indicator items
    - Create a metric
    - Manage metrics
  - Manage charts
    - Create a chart
    - Manage charts
  - OCP metrics
Inspection Management
- Inspection
- Configure inspection items
- Configure Scheduling Rules
  - Configure a scheduling rule for a single object
  - Configure a global scheduling rule
- Initiate Inspection
  - Initiate an inspection for a single object
  - Initiate a global inspection
- View an inspection task
- Manage Inspection reports
  - View an inspection report
  - Download an inspection report
Diagnostics and Tuning
- View the capacity center
- View the Optimization Center page
- View diagnostics reports
  - Manage ASH report
  - Performance report
- SQL Diagnostics
  - SQL Diagnostics Introduction
    - SQL diagnostics overview
    - SQL statement execution statistics
    - SQL execution plans
  - View the OceanBase Autonomy Service page
  - Suspicious SQL diagnostics
  - TopSQL diagnostics
  - View Comparison of Top SQL Statements
  - SlowSQL diagnostics
  - ParallelSQL diagnostics
  - High Risk SQL diagnostics
  - New SQL diagnostics
  - View details of an SQL statement
  - View outlines
  - View the SQL collection enable/disable history
  - View SQL request analysis
  - SQL performance diagnosis related parameter configuration
- Manage sessions
  - Manage the sessions of a tenant
  - View session statistics
  - View the deadlock history
- Transaction Diagnostics
  - Diagnostics Transaction
  - Overview of transaction
  - Diagnose XA transactions and suspended transactions
Backup and Recovery
- Overview
- Backup and recovery guide
- Initiate a restore task
- Overview
- View restore tasks
- Manage backup and recovery service
  - Stop a service on a node
  - Copy a service
  - Uninstall a service on a node
  - Add a node
  - Upgrade the version of a service
  - Restart a service on a node
  - Delete a service
  - View services
  - Install a service
  - Update service configurations
  - View O\&M tasks
- Manage backup tasks
  - View second backup tasks
  - View backup tasks
- Regular backup
  - Manage cluster-level backup strategy
    - View a cluster-level backup stategy
    - Create a cluster-level backup strategy
    - Modify a cluster-level backup strategy
    - Delete a cluster-level backup strategy
    - Pause backup scheduling
  - Manage tenant-level backup strategy
    - Pause backup scheduling
    - Create a tenant-level backup strategy
    - View a tenant-level backup stategy
    - Delete a tenant-level backup strategy
    - Modify a tenant-level backup strategy
- Regular recovery
  - View sampling strategies
  - View sampling tasks
  - Create a sampling strategy for recovery
- Backup now
  - Back up tenant now
  - Back up cluster now
Disaster Recovery
- Switching primary and standby databases
  - Start the original primary cluster in read-only mode after a failover
  - Decouple a standby cluster from the primary cluster
  - Primary/Standby cluster switchover for disaster recovery
  - Routine primary/standby cluster switchover
- Switching primary and standby tenants
  - Decouple a standby tenant from its primary tenant
  - Failover
  - Switchover
- OCP Manage OCP clusters in the multi-cluster mode
  - Register an OCP cluster
  - Switch an OCP cluster in a failover
  - OCP multi-cluster mode overview
  - Unbind a leader and a follower OCP cluster
  - Manage OCP cluster parameters
  - Switch an OCP cluster in daily maintenance
  - Enable the OCP multi-cluster mode
  - Delete a faulty follower OCP cluster
  - View Leader \& Follower Details
- OCP Manage OCP in multi-zone mode
  - View details of multiple zones
  - Manage parameters in multi-zone mode
  - Multi-zone overview
Log Management
- Download logs
- Trace query
- Query logs
- Configure trace query parameters
- About OpenSearch
Software Package Management
- Delete a software package
- Download a software package
- Upload a software package
System Management
- View Operation Audit
- Manage tasks
- Manage password box
  - Create a credential
  - Edit a credential
  - Verify a credential
  - Import a credential
  - Export a credential
  - Delete a credential
  - Batch operations on credentials
- Manage tags
  - Delete a tag
  - Overview
  - Modify objects bound to a tag
  - Edit a tag
  - Create a tag
- Manage system parameters
  - Modify system parameters
  - View system parameters
  - OCP configuration parameters
- Manage users
  - View users
  - Users overview
  - Create a user
  - Logon history
  - Delete a user
  - Copy a user
  - Change a user password
  - Edit a user
- Manage roles
  - Role overview
  - Default OCP roles
  - Delete a role
  - View a role
  - Copy a role
  - Create a role
  - Edit a role
- User center management
  - Change your logon password
  - Configure personal information
  - Log off the OCP console
SQL Tuning Practices
- General SQL Performance Tuning Scenarios
  - Execution Plan Optimization
    - SQL statement performance deterioration caused by plan changes
  - Index Optimization
    - Inappropriate index of an SQL statement
    - No suitable indexes
    - Invalid index of an SQL statement
- Customize Abnormal SQL Statement Determining Rules
  - Conditions
  - Custom column rules
- Locate General Abnormal SQL Statements
  - How can I locate SQL statements for full-table scans in a tenant?
  - How can I locate SQL statements with high CPU load in a tenant?
  - How can I locate slow hard-parsed SQL statements in a tenant?
  - How can I locate erroneous SQL statements in a tenant?
  - How can I locate distributed SQL statements in a tenant?
  - How can I locate slow SQL statements that take a long time in a tenant?
  - How can I locate remote SQL statements in a tenant?
O&M Best practices
- Send alert messages through email
- Send alert messages to a Feishu group
- Integrate OCP monitoring into Prometheus
- Troubleshoot host issues in an OceanBase cluster
- Push alert messages through HTTP
- Use the backup and restore module to restore data
- Monitor the business load of OceanBase Database
- Scale out an OceanBase cluster and scale up an OceanBase Database tenant
- Migrate an OceanBase cluster to another IDC
- Scale in an OceanBase cluster and scale down an OceanBase Database tenant
- Send alert messages to a WeChat Enterprise group
- Migrate a resource unit from an OceanBase Database tenant
- Send alert messages to a DingTalk group
- Upgrade an OceanBase cluster
- Scale out an OBProxy cluster
- Scale in an OBProxy cluster
- Replace an OBProxy
- Move out an OBProxy cluster
- Take over OBProxies
- Back up an OceanBase cluster
- Configure custom monitoring
- Perform an inspection in OCP to detect potential risks in an OceanBase cluster
- Check clog synchronization
- Check the NIC rate
- Check the availability of an auto-increment column
- Expand the high availability of OceanBase clusters and tenants
- Reduce the high availability of OceanBase clusters and tenants
- Perform a failover between primary and standby OceanBase clusters for disaster recovery in a scenario with two IDCs
Reference Guide
- Alarm reference
  - Alert Reference
  - Application alerts
    - ob_host_monitordb_disconnected
    - base_backup_too_long_time_no_one_success_task
    - backup_process_dead
    - odp_sql_query_slow
    - ob_cluster_inspection_not_passed
    - upgrade_ocp_agent_failed
    - monitor_exporter_unavailable
    - ob_host_tcp_retrans_percent_over_threshold
    - odp_instance_compress_failed
    - backup_storage_capacity_timeout_or_interrupted
    - ob_host_invalid_disk_exists
    - ocp_remote_server_time_diff_too_large
    - host_agent_open_fd_count_over_threshold
    - ic_server_connect_failed Inter-Connector
    - Host log alerts
    - host_agent_goroutine_count_over_threshold
    - obagent_dead
    - host_ntp_service_not_exist
    - host_ntp_offset_too_large
    - backup_storage_capacity_over_threshold
    - base_backup_timeout
    - partition_create_failed
    - host_disk_readonly
    - ocp_http_request_timeout
    - ocp_collect_metric_failure_rate_high
    - host_agent_res_memory_over_threshold
    - ob_host_net_recv_percent_over_threshold
    - vpc_connect_failed
    - odp_sql_execute_failed
    - ob_host_ssd_wear_indicator_over_threshold
    - mgragent_process_stop
    - host_agent_version_not_same
    - agentd_process_stop
    - base_backup_fail
    - ocp_alarm_detect_timeout
    - ob_host_net_send_percent_over_threshold
    - ob_host_cpu_percent_over_threshold
    - monagent_process_stop
    - ocp_meta_db_disconnected
    - ocp_contingency_failed
    - system_obproxy_unavailable
    - node_load1_peak
    - base_secondary_backup_fail
    - ob_host_mem_percent_over_threshold
    - backup_storage_capacity_retry_times_exceeded
    - odp_instance_expanse_failed
    - inc_backup_delay
    - ocp_http_request_too_many_errors_occur
    - ob_cluster_recyclebin_disk_used_over_threshold
    - host_unavailable
  - OceanBase alerts
    - ob_cluster_rs_not_same
    - ob_tenant_expired_trans_exist
    - ob_cluster_merge_timeout
    - standby_tenant_sync_delay_too_long
    - ob_cpu_assigned_percent_over_threshold
    - ob_cpu_percent_over_threshold
    - ob_tenant_large_trans_exist
    - ob_cluster_operation_info
    - obproxy_core_dump
    - ob_cannot_connected
    - ob_cluster_frozen_version_delta_over_threshold
    - OceanBase log alerts
    - obproxy_process_dead
    - refresh_location_cache_failed_by_metric
    - ob_server_sstable_percent_over_threshold
    - ob_tenant_no_frozen
    - oas_anomaly_sql_from_anomaly_event_analysis_cpu_percent_high
    - ob_tenant_partition_replica_absent
    - obproxy_client_connections_usage_over_threshold
    - ob_cluster_no_frozen
    - ob_host_task_timeout
    - ob_host_load1_per_cpu_over_threshold
    - oas_anomaly_sql_from_anomaly_event_analysis_perf_degradation
    - ob_host_install_disk_percent_over_threshold
    - obproxy_cannot_connected
    - host_operation
    - oas_anomaly_sql_from_anomaly_event_analysis_plan_changed
    - agent_process_count_abnormal
    - ob_tenant_compaction_error
    - ob_tenant500_storage_short_meta_mem_hold_high
    - refresh_location_cache_failed
    - ob_tenant_exists_expired_xa_trans
    - ob_cluster_sync_failed
    - ob_cluster_merge_error
    - ob_host_disk_readonly
    - os_observer_not_exist
    - ob_tenant_active_session_count_over_threshold
    - ob_tenant_cpu_usage_over_threshold
    - standby_tenant_sync_status_error
    - ob_tenant_log_disk_usage_high
    - ob_server_cannot_connect_arbitration
    - ob_cluster_no_merge
    - ob_cluster_status_check_failed
    - ob_cluster_sync_delay_time_too_long
    - obproxyd_process_dead
    - ob_host_data_disk_percent_over_threshold
    - ob_tenant_long_trans_exist
    - ob_mem_assigned_percent_over_threshold
    - obproxy_process_stop
    - ob_tenant_expired_trans_exist
    - obproxy_host_operation
    - tenant_memstore_percent_over_threshold
    - ob_host_partition_count_over_threshold
    - oas_anomaly_sql_from_sql_inspection_perf_degradation
    - observer_process_stop
    - ob_tenant_log_stream_degraded
    - tenant_active_memstore_percent_over_threshold
    - ob_tenant_request_queue_over_threshold
    - ob_tenant_no_compaction
    - ob_tenant_operation_info
    - ob_tenant500_mem_hold_percent_over_threshold
    - ob_host_operation
    - ob_host_active_session_count_over_threshold
    - ob_cluster_active_session_count_over_threshold
    - ob_host_log_disk_percent_over_threshold
    - ob_host_connection_percent_over_threshold
    - ob_tenant_partition_leader_absent
    - oas_anomaly_sql_from_sql_inspection_plan_changed
    - obproxy_cluster_operation
    - arbitration_service_unavailable
    - ob_tenant_long_trans_exist
    - obproxyd_process_stop
    - ob_cluster_exists_index_fail_table
    - same_alarm_rule_detect_too_many_targets
    - tenant_cpu_percent_over_threshold
    - ob_cluster_exists_inactive_server
    - ob_tenant_task_timeout
    - ob_tenant_slow_sql_exists
    - ob_tenant500_mem_hold_over_threshold
  - OAS alerts
    - node_memory_peak
    - os_nic_1000m_full
    - os_tsar_cpu_util_hwm
    - os_observer_fd_usage
    - os_tsar_traffic_error
    - os_tsar_cpu_util_full
    - os_kernel_ntp_delay
    - node_file_datalog1_usage
    - os_home_file_usage
    - os_tsar_nvme_ioawait
    - os_tsar_cpu_sys_abnormal
    - os_tsar_traffic_overload
    - os_tsar_traffic_drop
    - os_tsar_sda_ioawait
    - os_kernel_io_hang
    - sql_audit_collect_lost_percent_over_threshold
    - node_file_inode_usage
    - node_file_root_usage
    - node_file_data1_usage
    - os_kernel_ntp_down
    - os_nic_1000m_hwm
    - os_cpu_irq_error
    - os_observer_core_dump
  - Appendix
    - Network troubleshooting
    - Execute the alert clearance plan
    - Exception handling for OceanBase cluster compaction
    - Apply throttling to an OceanBase cluster
- API Reference
  - Overview
  - API call description
  - Rules for generating a signature by using AK/SK
  - Task return structure
  - Task management
    - Query details about a task
    - Roll back a task
    - Skip a subtask
    - Retry a task
    - Query tasks
    - Query logs of a subtask instance
    - Cancel a subtask
    - Retry a subtask
  - Cluster information
    - Restart a zone in an OceanBase cluster
    - Perform a failover
    - Start an OBServer
    - Delete a zone from an OceanBase cluster
    - Delete multiple OBServers at a time
    - Change the password of an OceanBase cluster
    - Query servers
    - Stop an OceanBase cluster
    - Stop an OBServer
    - Query clusters
    - Restart an OBServer
    - Query servers in a zone
    - Delete an OceanBase cluster
    - Query parameters of an OceanBase cluster
    - Perform a failover pre-check
    - Stop a zone in an OceanBase cluster
    - Create an OceanBase cluster
    - Replace an OBServer
    - Perform a switchover pre-check
    - Query zones of an OceanBase cluster
    - Modify parameters of an OceanBase cluster
    - Upgrade an OceanBase cluster
    - Add an OBServer
    - Start a zone in an OceanBase cluster
    - Restart an OceanBase cluster
    - Query the parameter metadata of an OceanBase cluster
    - Start an OceanBase cluster
    - Create a zone for an OceanBase cluster
    - Perform a switchover
  - Backup and recovery
    - Query the backup strategy of a cluster
    - Initiate tenant recovery
    - Query the backup overview of a cluster
    - Query log backup tasks of a cluster
    - Query data backup tasks of a cluster
    - Immediately back up a cluster
    - Delete the backup strategy of a cluster
    - Modify the backup strategy of a cluster
    - Create a backup strategy for a cluster
    - Parse cluster backup data
    - Query recovery tasks of a cluster
    - Query backup capabilities of a cluster
  - OceanBase user and privilege management
    - Delete a database user
    - Revoke roles of a user
    - Query database role details
    - Lock a database user
    - Change global privileges of a user
    - Change roles of a user
    - Change object privileges of a user
    - Delete a database role
    - Grant database privileges to a user
    - Unlock a database user
    - Change the password of a database user
    - Create a database role
    - Query the database role details
    - Revoke object privileges of a user
    - Query database user details
    - Create a database user
    - Query database user details
    - Grant object privileges to a user
    - Change object privileges of a role
    - Revoke database privileges of a user
    - Revoke global privileges of a user
    - Grant global privileges to a user
    - Revoke roles of a role
    - Revoke object privileges of a role
    - Revoke global privileges of a role
    - Grant roles to a user
    - Grant roles to a role
    - Grant object privileges to a role
    - Change global privileges of a role
    - Change roles of a role
    - Query database objects
    - Grant global privileges to a role
    - Change database privileges of a user
  - OBProxy management
    - Delete an OBProxy
    - Remove a connectable OceanBase cluster from an OBProxy cluster
    - Query the parameter metadata of an OBProxy
    - Query OBProxy clusters
    - Restart an OBProxy
    - Update configurations of an OBProxy cluster
    - Take over an OBProxy
    - Delete an OBProxy cluster
    - Create an OBProxy cluster
    - Upgrade an OBProxy
    - Add a connectable OceanBase cluster for an OBProxy cluster
    - Query details about an OBProxy cluster
    - Query parameters of an OBProxy cluster
    - Add an OBProxy
  - Software packages
    - Delete a software package
    - Query software packages
    - Upload a software package
  - Hosts
    - Query IDCs
    - Query regions
    - Delete a host type
    - Query details about a region
    - Query details about an IDC
    - Query host types
    - Query details about a host
    - Add multiple hosts at a time
    - Add a region
    - Delete a region
    - Delete a host
    - Delete multiple hosts at a time
    - Add a host type
    - Query hosts
    - Delete an IDC
    - Query details about a host type
    - Add an IDC
  - OCP Agent management
    - Restart basic OCP Agent processes on a host
    - Stop OCP Agent processes on a host
    - Batch restart basic OCP Agent processes on a host
    - Query OCP Agent processes on a host
    - Stop basic OCP Agent processes on a host
    - Query OCP Agent details on a host
    - Restart OCP Agent processes on a host
    - Batch stop basic OCP Agent processes on a host
  - Tenant information
    - Delete a unit from a tenant
    - Create a tenant
    - Delete a replica of a tenant
    - Unlock a tenant
    - Query parameters of a tenant
    - Query all tenants
    - Query units of a tenant
    - Query tenants of a cluster
    - Query details about a tenant
    - Modify a replica of a tenant
    - Create a tenant
    - Modify the whitelist of a tenant
    - Modify zone priorities of a tenant
    - Change the administrator password of a tenant
    - Obtain a list of unit specifications
    - Create a resource unit specification
    - Modify parameters of a tenant
    - Lock a tenant
    - Add a replica for a tenant
    - Delete a tenant
    - Delete a resource unit specification
    - OceanBase database management
      - Create a database
      - Modify a database
      - Delete a database
      - Query databases
  - Alerts
    - Call an alert API
    - Alert events
      - Query alert events
      - Query the alert event list
    - Alert notifications
      - Query alert notifications
  - OCP event history
    - Query event history
  - SQL performance
    - Query the operator structure of an execution plan
    - Query performance indicators of an SQL statement
    - Query the performance indicator trend of an SQL statement
    - Query performance indicators of an execution plan
    - Query the performance indicator trend of an execution plan
    - Query SQL text
  - Health examination
    - Query OCP server time
    - Query the basic information of an OCP application
    - Query OCP application status
  - Monitoring
    - Query monitoring data and group the queried data by tag
    - Query monitoring data
    - Query the metadata of a monitoring metric
- Metric reference
  - Overview of metrics
  - Monitoring metrics list
  - OceanBase Database tenant
    - Number of XA statements
    - TPS
    - Cache size
    - I/O Throughput
    - Number of XA transactions
    - Number of transaction logs
    - Partitions
    - IOPS
    - SQL execution plan category
    - Transaction response time
    - Tenant CPU cost
    - Request waiting queue
    - Response time
    - Average execution duration of XA statements
    - Rpc package rt
    - Cursors
    - Request queue size
    - Waiting for events
    - Tenant thread usage
    - QPS
    - Sessions
    - Transaction log volume
    - Time consumed by transaction logs
    - memroy usage pecent
    - Cache hit rates
    - MemStore usage
    - IO time-consuming
    - Clog synchronization delay
    - Lock waits
    - MemStore
    - TPS
    - Transaction response time details
    - Transaction table read request hits
    - Waiting for event time
    - Number of cache requests
    - Request waiting queue time consuming
    - Time consumed by lock waits
    - RPC packet throughput
    - SQL execution plan time
  - OBProxy cluster
    - Memory for the obproxy process
    - Client connections
    - Number of threads in the obproxy process
    - Number of file descriptors for the obproxy process
    - TPS
    - Server connections
    - Average bytes in a network request or response
    - QPS
    - CPU utilization of the obproxy process
    - Number of error logs
    - Average route table queries per second
    - Average response time for each SQL statement
  - Host
    - IOPS
    - CPU Utilization
    - I/O throughput
    - Network throughput
    - Process CPU utilization
    - Number of process threads
    - NTP clock offset
    - Disk
    - Inode usage
    - Number of OCP-Agent process goroutines
    - I/O queue length
    - Packet forwarding
    - I/O usage
    - Time consumed by I/O operations
    - Memory
    - Process resident memory
    - Linux system load
    - Memory usage
    - Number of process file descriptors
    - TCP retransmission rate
  - OceanBase cluster
    - Time consumed by transaction logs
    - Number of transaction logs
    - Process file descriptors
    - Request queue time
    - TPS
    - Transaction response time
    - I/O Throughput
    - Transaction log volume
    - IOPS
    - QPS
    - Number of process threads
    - Process memory
    - Number of sessions
    - TPS
    - Query response time
    - IO time-consuming
    - sys500 memory occupation
    - Process CPU utilization
    - Error logs
FAQ
- FAQ on the OCP system
- FAQ about deployment
- FAQ on alerts
- OCP multi-cluster FAQ
- FAQ on upgrade
- FAQ on monitoring
  - FAQ on monitoring metrics
  - FAQ on SQL monitoring
  - FAQ about resource usage
  - Use OCP-Agent to pull time-series monitoring data
- FAQ on O&M
  - FAQ on backup and recovery
  - FAQ on the OCP software package
  - FAQ on OceanBase cluster
  - FAQ on OBProxy
  - FAQ on OceanBase tenants
  - FAQ on accounts and passwords
  - FAQ on host management
Appendix
- Component listening port list
- Processes
- OCP background tasks
- OCP error codes
- Tables managed by the daemon

Download PDF

Document Feedback

Start the original primary cluster in read-only mode after a failover

Last Updated：2026-04-14 07:56:02 Updated

This topic describes how to start the original primary cluster in read-only mode after a failover.

Background information

After you perform a failover, the cluster exists in the disabled state and can only be deleted. After the failover, some data in the original primary cluster may be missing from the new primary cluster. You can start the original primary cluster in read-only mode, compare the data of the new primary cluster with that of the original primary cluster, and update the new primary cluster if necessary based on the result of the comparison.

Prerequisites

The current cluster is the original primary cluster and must be in the DISABLED state.
The logged-on user has the permission to manage the cluster.
The OceanBase Database version is V2.2.76 BP1 or later.

Procedure

Log on to the OceanBase Cloud Platform (OCP) console. In the left-side navigation pane, click Clusters . In the Clusters list, click the name of the target cluster.
On the Overview page of the cluster, click Start as Read-Only Cluster in the upper right corner.
In the dialog box that appears, click Start .

When the cluster is starting, the cluster status changes to Starting read-only cluster . After the cluster is started, the cluster status changes to Running and the cluster is marked as Read-Only Cluster .

Note
When the cluster is in the Starting read-only cluster state, you cannot perform any operation on the cluster.

Previous topic

Decouple a standby cluster from the primary cluster

Last

Next topic

OCP multi-cluster mode overview