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 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.3.5

Document Overview
Product Introduction
- What is OceanBase Cloud Platform?
- Differences between Enterprise Edition and 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
    - Check the NTP offset
- 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
  - Move out a cluster
  - Delete a cluster
  - Change the password
  - Manage Arbitration Service of a cluster
    - Add an arbitration service
    - Add an arbitration service group
    - Replace the arbitration service for a cluster
    - Remove an arbitration service
  - Enable automatic detection of deadlocks
  - Disable automatic detection of deadlocks
  - Manage O&M configuration
    - Overview
    - Manage parameters
    - View the parameter modification history
    - Configure resources for OCP Agent
  - Manage CPU binding configurations
- Manage zones of a cluster
  - Add a zone
  - Edit 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 a major compaction
  - View statistics of a major compaction
  - View the major compaction records
- Manage cluster parameters
  - Parameter types
  - View parameters
  - Modify parameters
  - View the history of parameter changes
- Manage Arbitration Services
  - 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
  - Replace an arbitration service
  - Associate a cluster
  - Dissociate an arbitration service
  - Delete an arbitration service
- Manage Service Groups
  - Overview
  - Create an arbitration service group
  - Upgrade an arbitration service group
  - Edit an arbitration service group
  - Delete an arbitration service group
- Manage cluster parameter templates
Tenant Management
- Tenant and resource management
- View tenant overview information
- Create a primary tenant
- Manage tenants
  - View the details of a tenant
  - Create a standby tenant
  - Copy a tenant
  - Rename a tenant
  - Lock a tenant
  - Clone 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 the binlog service for a tenant
  - Manage service names
- Manage topulogy of a tenant
  - View the topology of a tenant
  - View the topology of the 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
  - View details of tenant major compaction
  - Perform a major compaction
  - View the major compaction records
- Manage statistical information
  - Overview
  - Collect statistics
  - Manage statistics collection tasks
- Manage tenant parameters
  - View the parameters
  - Modify a parameter
  - View the parameter modification history
- Manage unit specifications
- View OCP resource unit specifications
- Manage tenant parameter templates
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
  - Move out an OBProxy cluster
  - Delete an OBProxy cluster
  - Upgrade an OBProxy cluster
  - Manage CPU core binding configurations
  - 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
- Manage OBProxy parameter templates
- OBProxy parameters descpription
Binlog Service Management
- Binlog service overview
- Create a binlog cluster
- Manage Binlog Clusters
  - View information about a binlog cluster
  - Upgrade a binlog cluster
  - Start and stop a binlog cluster
  - Restart a binlog cluster
  - Delete a binlog cluster
  - Manage Binlog Instance
    - View a binlog instance
    - Configure throttling
    - Start and stop a binlog instance
    - Restart a binlog instance
    - Manage binlog instance parameters
  - Manage Binlog Server
    - Add a binlog node
    - Start and stop a binlog server
    - Delete a binlog server
    - Clear binlog instances on a host
- Manage binlog cluster parameters
- Manage binlog parameter templates
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
  - Overview
  - View database performance monitoring data
  - View host performance monitoring data
  - View OBServer node performance monitoring data
  - View performance and SQL monitoring data
  - View transaction performance monitoring data
  - View storage and cache monitoring data
  - View database object monitoring data
  - View OBKV-Table monitoring data
  - View OBKV-HBase monitoring data
  - View OBKV-Redis monitoring data
  - View subscription connection monitoring charts
  - View performance monitoring data of a binlog instance
  - View resource monitoring data of a binlog instance
  - View host resource monitoring data
  - View host process monitoring data
  - View service monitoring data
  - View system monitoring data
  - View performance monitoring
  - Drill-down monitoring
  - Integrate monitoring data to an external time-series system
- 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
Diagnostics and Tuning
- SQL Diagnostics
  - SQL Diagnostics Introduction
    - SQL diagnostics overview
    - SQL statement execution statistics
    - SQL execution plans
  - View the OceanBase Autonomy Service page
  - Diagnose suspicious SQL statements
  - Diagnose top SQL statements
  - View Comparison of Top SQL Statements
  - Diagnose slow SQL statements
  - Diagnose parallel SQL statements
  - Diagnose high-risk SQL statements
  - Diagnose new SQL statements
  - View the details of an SQL statement
  - View outlines
  - View the SQL collection enabling/disabling history
  - View SQL request analysis data
  - Parameters related to SQL performance diagnostics
- Transaction Diagnostics
  - Transaction overview
  - Diagnose transactions
  - Diagnose XA transactions and suspended transactions
- Manage sessions
  - Manage the sessions of a tenant
  - View session statistics
  - View the deadlock history
  - View row lock analytics
- View the Optimization Center page
- View the capacity center
- View diagnostics reports
  - Manage ASH reports
  - Manage performance reports
O&M Management
- Manage Information Collection
  - Overview
  - Configure information collection items
  - Create an information collection task
  - View information collection details
  - Download an information collection report
- Manage Plans
  - Overview
  - Manage plans
  - View plan execution details
- Manage Inspection
  - 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
Backup and Recovery
- Copy a restore task
- Overview
- Backup and restore guide
- Initiate a restore task
- Overview
- View restore task information
- Manage backup tasks
  - View backup tasks
  - View second backup tasks
- Manage backup and recovery service
  - View services
  - 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
- Regular backup
  - Manage cluster-level backup strategy
    - Create a cluster-level backup strategy
    - Modify a cluster-level backup strategy
    - Delete a cluster-level backup strategy
    - Pause backup scheduling
    - View a cluster-level backup stategy
  - Manage tenant-level backup strategy
    - Create a tenant-level backup strategy
    - Modify a tenant-level backup strategy
    - Delete a tenant-level backup strategy
    - Pause backup scheduling
    - View a tenant-level backup stategy
- Regular recovery
  - Create a sampling strategy for recovery
  - View sampling strategies
  - View sampling tasks
- Backup now
  - Back up a cluster now
  - Back up a tenant now
Disaster Recovery
- Switching primary and standby databases
  - Routine primary/standby cluster switchover
  - Primary/Standby cluster switchover for disaster recovery
  - Decouple a standby cluster from the primary cluster
  - Start the original primary cluster in read-only mode after a failover
- Switching primary and standby tenants
  - Switchover
  - Failover
  - Decouple a standby tenant from its primary tenant
  - Create a standby tenant for a primary tenant managed by another OCP cluster
- OCP Manage OCP clusters in the multi-cluster mode
  - OCP multi-cluster mode overview
  - Register an OCP cluster
  - View 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
  - Enable the OCP multi-cluster mode
Log Management
- Download logs
- Configure log retention strategies
- 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 records
- Manage tasks
- Manage users and permissions
  - Overview
  - Manage a organization
    - Create an organization
    - View the resources of an organization
    - Rename an organization
    - Share resource configurations
    - Delete an organization
  - Manage a role
    - Create a role
    - View a role
    - Edit a role
    - Copy a role
    - Delete a role
    - Default OCP roles
  - Manage a user
    - Create a user
    - View a user
    - Edit a user
    - Copy a user
    - Change the password of a user
    - Delete a user
    - View the login history
- Manage tags
  - Overview
  - Create a tag
  - Modify objects bound to a tag
  - Edit a tag
  - Delete a tag
- Manage password box
  - Create a credential
  - Export a credential
  - Import a credential
  - Verify a credential
  - Edit a credential
  - Delete a credential
  - Batch operations on credentials
- Manage system parameters
  - View system parameters
  - Modify system parameters
  - OCP configuration parameters
- Manage external integration
  - Overview
  - Create an SSO integration task
  - Enable/Disable an SSO integration task
  - Edit an SSO integration task
  - Delete an SSO integration task
- User center management
  - Configure personal information
  - Change your logon password
  - 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
    - No suitable indexes
    - Inappropriate index of an SQL statement
    - 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 with high CPU load in a tenant?
  - How can I locate slow SQL statements that take a long time in a tenant?
  - How can I locate SQL statements for full-table scans in a tenant?
  - How can I locate distributed SQL statements in a tenant?
  - How can I locate remote SQL statements 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?
O&M Best practices
- Send alert messages through email
- Move out an OBProxy cluster
- Check the availability of an auto-increment column
- Decouple a standby tenant from the primary tenant
- Perform a failover
- Check clog synchronization
- Send alert messages to a Feishu group
- Integrate OCP monitoring into Prometheus
- Troubleshoot host issues in an OceanBase cluster
- Push alert messages through HTTP
- Back up an OceanBase cluster
- Automatic routing to the new primary tenant after a switchover
- Scale in an OBProxy cluster
- Perform an inspection in OCP to detect potential risks in an OceanBase cluster
- Take over OBProxies
- Scale in an OceanBase cluster and scale down an OceanBase Database tenant
- Use the arbitration service of OceanBase Database to achieve HA in a scenario with two IDCs
- Configure custom monitoring
- Migrate a cluster between IDCs in OCP
- Scale out an OBProxy cluster
- Restore lost data by using backup and restore
- Migrate a resource unit from an OceanBase Database tenant
- Import a monitoring dashboard to Grafana
- Send alert messages to a WeChat Enterprise group
- Monitor the business load of OceanBase Database
- Upgrade an OceanBase cluster
- Expand 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
- Replace an OBProxy
- Reduce the high availability of OceanBase clusters and tenants
- Scale out an OceanBase cluster and scale up an OceanBase Database tenant
- Check the NIC rate
- Migrate an OceanBase cluster to another IDC
- Perform a switchover between primary and standby OceanBase Database tenants in a scenario with two IDCs
- Delete an OBProxy
- Send alert messages to a DingTalk group
Reference Guide
- Alarm reference
  - Overview
  - 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
    - OceanBase log alerts
    - 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
    - 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
    - host_operation
    - obproxy_host_operation
    - obproxy_cluster_operation
    - ob_host_operation
    - refresh_location_cache_failed
    - ob_tenant_log_stream_degraded
    - arbitration_service_unavailable
    - observer_process_stop
    - obproxyd_process_stop
    - obproxy_process_stop
    - standby_tenant_sync_delay_too_long
    - standby_tenant_sync_status_error
    - obproxy_client_connections_usage_over_threshold
    - ob_tenant_request_queue_over_threshold
    - oas_anomaly_sql_from_anomaly_event_analysis_cpu_percent_high
    - oas_anomaly_sql_from_anomaly_event_analysis_perf_degradation
    - oas_anomaly_sql_from_anomaly_event_analysis_plan_changed
    - oas_anomaly_sql_from_sql_inspection_perf_degradation
    - oas_anomaly_sql_from_sql_inspection_plan_changed
    - os_observer_not_exist
    - refresh_location_cache_failed_by_metric
    - ob_tenant_cpu_usage_over_threshold
    - ob_tenant_partition_replica_absent
    - ob_tenant_partition_leader_absent
    - ob_tenant500_storage_short_meta_mem_hold_high
    - obproxy_core_dump
    - ob_server_cannot_connect_arbitration
    - agent_process_count_abnormal
    - arbitration_auto_replace_operation_info
    - arbitration_group_auto_replace_failed
  - 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
    - odp_sql_execute_failed
    - ocp_collect_metric_failure_rate_high
    - host_agent_res_memory_over_threshold
    - ob_host_net_recv_percent_over_threshold
    - vpc_connect_failed
    - ocp_http_request_timeout
    - 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
  - 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
- Metric reference
  - Overview of metrics
  - Monitoring metrics list
  - OBProxy cluster
    - TPS
    - QPS
    - Client connections
    - Server connections
    - Average response time for each SQL statement
    - Memory for the obproxy process
    - OBProxy CPU usage
    - Number of file descriptors for the obproxy process
    - Number of threads in the obproxy process
    - Log error
    - Route table queries
    - Net bytes
    - RPC sessions
    - RPC requests
    - RPC request time consumption
  - OceanBase Database tenant
    - Performance and SQL
      - QPS
      - Response time (SQL mode)
      - SQL execution plan category
      - SQL execution plan time
      - Sessions
      - Wait events
      - Metrics related to time consumption of wait events
      - Request waiting queue
      - Request waiting queue time consuming
      - Request queue size
      - Tenant CPU cost
      - Tenant thread usage
      - memroy usage pecent
      - MemStore usage
      - Rpc package rt
      - RPC packet throughput
      - Cursors
      - Clog synchronization delay
      - DB time metrics
      - Metrics for the SQL execution phase
      - Frontend workload metrics
      - Background workload metrics
      - PX worker thread usage
    - Transaction
      - TPS
      - Transaction response time
      - Transaction response time details
      - Number of transaction logs
      - Transaction log volume
      - Time consumed by transaction logs
      - Lock waits
      - Time consumed by lock waits
      - TPS
      - Transaction table read request hits
      - Partitions
      - Number of XA transactions
      - Number of XA statements
      - Average execution duration of XA statements
    - Storage and Cache
      - MemStore
      - IOPS
      - IO time-consuming
      - I/O Throughput
      - Cache size
      - Cache hit rates
      - Number of cache requests
      - Frozen MemStores
      - # Log disk
      - # Data disk
    - Database objects
      - Objects
    - OBKV_Table
      - QPS (OBKV-Table)
      - Response time (OBKV-Table)
      - Average number of statement lines processed (OBKV-Table)
    - OBKV_HBase
      - QPS (OBKV_Hbase)
      - Response time (OBKV-HBase)
      - Average number of statement lines processed (OBKV-HBase)
    - OBKV_Redis
      - QPS (OBKV-Redis)
      - Response time (OBKV-Redis)
  - Host
    - Host Performance
      - Linux system load
      - CPU Utilization
      - I/O usage
      - I/O queue length
      - IOPS
      - Time consumed by I/O operations
      - I/O throughput
      - Network throughput
      - TCP retransmission rate
      - Packet forwarding
      - NTP clock offset
      - Inode usage
    - Host Resources
      - Memory
      - Memory usage
      - Disk
    - Host Processes
      - Process resident memory
      - Process CPU utilization
      - Number of process file descriptors
      - Number of process threads
      - Number of OCP-Agent process goroutines
  - OceanBase cluster
    - Database performance
      - QPS
      - Query response time
      - TPS
      - Transaction response time
      - Number of sessions
      - Request queue time
      - Number of transaction logs
      - Transaction log volume
      - Time consumed by transaction logs
      - IOPS
      - IO time-consuming
      - I/O Throughput
      - TPS
    - OBServer performance
      - Process memory
      - Process CPU utilization
      - Process file descriptors
      - Number of process threads
      - sys500 memory occupation
      - Error logs
  - Binlog Service
    - Subscription Connection Monitoring
      - Sending Delay
      - Associate RPS
      - Network Traffic
    - Binlog Performance Monitoring
      - Binlog Delay
      - Binlog RPS
    - Binlog Resource Monitoring
      - CPU
      - memory used
      - memory
      - disk used
      - Binlog Disk Write Rate
      - disk ratio
      - FD count
      - network bytes
- API Reference
  - Overview
  - API call description
  - Rules for generating a signature by using AK/SK
  - Task return structure
  - Software packages
    - Query software packages
    - Delete a software package
    - Upload a software package
  - Cluster management
    - Migrate an arbitration service
    - Query arbitration service parameters
    - Perform a failover
    - Upgrade an arbitration service group
    - Start a zone in an OceanBase cluster
    - Delete multiple OBServers at a time
    - Perform a precheck on batch arbitration service replacement
    - Stop an OceanBase cluster
    - Perform a takeover precheck on an OceanBase cluster
    - Create a zone for an OceanBase cluster
    - Start an OceanBase cluster
    - Start an arbitration service
    - Delete a zone from an OceanBase cluster
    - Query the list of arbitration services
    - Change the password of an OceanBase cluster
    - Take over an arbitration service
    - Delete an arbitration service group
    - Restart a zone in an OceanBase cluster
    - Query resource statistics of all OBServer nodes in an OceanBase cluster
    - Query the parameter metadata of OceanBase clusters
    - Take over an OceanBase cluster
    - Add an OBServer node
    - Delete an OceanBase cluster
    - Perform a switchover pre-check
    - Delete an arbitration service
    - Query resource statistics of an OceanBase cluster
    - Stop an OBServer node
    - Associate an arbitration service with multiple OceanBase clusters
    - Create an arbitration service group
    - Upgrade an OceanBase cluster
    - Bind/Unbind tags to/from an arbitration service
    - Query information of an arbitration service group
    - Stop an arbitration service
    - Query details of an arbitration service
    - Query units of an OceanBase cluster
    - Perform a switchover
    - Replace the arbitration service for multiple clusters
    - Create an arbitration service
    - Restart an arbitration service
    - Restart an OceanBase cluster
    - Restart an OBServer node
    - Query zones of an OceanBase cluster
    - Start an OBServer node
    - Create an OceanBase cluster
    - Query parameters of an OceanBase cluster
    - Perform an arbitration service takeover precheck
    - Query OBServer nodes in a zone
    - Move out an OceanBase cluster
    - Perform an association precheck on multiple OceanBase clusters
    - Dissociate an arbitration service from multiple clusters
    - Upgrade an arbitration service
    - Stop a zone in an OceanBase cluster
    - Replace an OBServer node
    - Modify parameters of an OceanBase cluster
    - Query OBServer nodes of an OceanBase cluster
    - Query OceanBase clusters
    - Query the list of arbitration service groups
    - Update an arbitration service group
    - Perform a failover pre-check
  - Database management
    - Grant roles to a user
    - Grant database privileges to a user
    - Grant object privileges to a user
    - Query database objects
    - Revoke global privileges of a role
    - Query the list of database roles
    - Change object privileges of a role
    - Grant global privileges to a role
    - Change global privileges of a role
    - Grant global privileges to a user
    - Query database user details
    - Change database privileges of a user
    - Delete a database user
    - Query databases
    - Revoke database privileges of a user
    - Grant roles to a role
    - Change roles of a role
    - Create a database user
    - Create a database role
    - Lock a database user
    - Change object privileges of a user
    - Query database role details
    - Delete a database role
    - Revoke roles of a user
    - Query the list of database users
    - Delete a database
    - Revoke object privileges of a user
    - Revoke roles of a role
    - Change global privileges of a user
    - Unlock a database user
    - Change the password of a database user
    - Modify a database
    - Grant object privileges to a role
    - Create a database
    - Change roles of a user
    - Revoke global privileges of a user
    - Revoke object privileges of a role
  - System management
    - Operation Audit
      - Query event history
    - Health examination
      - Query the basic information of an OCP application
      - Query OCP server time
      - Query OCP application status
    - Agent management
      - Stop the OCP Agent process on a host
      - Stop the OCP Agent process on a host
      - Restart the OCP Agent process on a host
      - Query OCP Agent details on a host
      - Batch stop the OCP Agent processes on hosts
      - Batch restart the OCP Agent processes on hosts
      - Restart the OCP Agent process on a host
      - Query OCP Agent processes on a host
  - SQL performance
    - Query the performance indicator trend of an SQL statement
    - Query performance indicators of an SQL statement
    - Query a performance report
    - Query the operator structure of an execution plan
    - Query the list of slow SQL statements
    - Query SQL text
    - Generate a performance report
    - Query snapshots
    - Query the performance indicator trend of an execution plan
    - Query performance indicators of an execution plan
  - O&M tasks management
    - Query details about a task
    - Query tasks
    - Retry a task
    - Cancel a subtask
    - Roll back a task
    - Retry a subtask
    - Query subtask logs
    - Skip a subtask
  - Backup and recovery
    - View the log backup tasks of a tenant
    - View the data backup tasks of a tenant
    - Delete the backup strategy of a cluster
    - Parse the backup information of a tenant
    - Initiate tenant recovery
    - View restore tasks
    - Query the backup strategy of a tenant
    - Start backup scheduling for a cluster
    - Clear added restore resources
    - Query recovery tasks of a cluster
    - Stop backup scheduling for a tenant
    - Query the backup overview of a cluster
    - Modify the backup strategy of a cluster
    - Query backup capabilities of a cluster
    - Query the backup strategy of a cluster
    - Create a backup strategy for a tenant
    - Parse cluster backup data
    - Initiate a data backup for a tenant
    - Modify the backup strategy of a tenant
    - Query data backup tasks of a cluster
    - Start backup scheduling for a tenant
    - Add restore resources
    - Create a backup strategy for a cluster
    - Immediately back up a cluster
    - Preview a restore task
    - Delete the backup strategy of a tenant
    - Stop backup scheduling for a cluster
    - Query log backup tasks of a cluster
  - OBProxy management
    - Update configurations of an OBProxy cluster
    - Restart an OBProxy
    - Upgrade an OBProxy
    - Remove a connectable OceanBase cluster from an OBProxy cluster
    - Create an OBProxy cluster
    - Query the description information of the OBProxy parameters
    - Delete an OBProxy (not recommended)
    - Start an OBProxy
    - Query details about an OBProxy cluster
    - Add an OBProxy
    - Take over an OBProxy
    - Stop an OBProxy
    - Add a connectable OceanBase cluster for an OBProxy cluster
    - Query parameters of an OBProxy cluster
    - Upgrade an OBProxy
    - Delete an OBProxy cluster
    - Query OBProxy clusters
    - Delete an OBProxy
    - Restart an OBProxy
  - Tenant management
    - Create a tenant
    - Modify a replica of a tenant
    - Modify parameters of a tenant
    - Query tenants of a cluster
    - Create a standby tenant
    - Obtain a list of unit specifications
    - Delete a unit from a tenant
    - Perform a batch failover
    - Add a replica for a tenant
    - Create a resource unit specification
    - Perform a batch switchover
    - Unlock a tenant
    - Perform a switchover
    - Perform a failover precheck
    - Query all tenants
    - Query parameters of a tenant
    - Delete a replica of a tenant
    - Change the administrator password of a tenant
    - Delete a resource unit specification
    - Perform a batch switchover precheck
    - Query details about a tenant
    - Modify the allowlist of a tenant
    - Perform a switchover precheck
    - Lock a tenant
    - Perform a batch failover precheck
    - Modify zone priorities of a tenant
    - Query units of a tenant
    - Delete a tenant
    - Perform a failover
  - Inspection
    - Query inspection objects
    - Query the last inspection result of an inspection item
    - Initiate an inspection
    - Query the last inspection result of an inspection object
    - Query all inspection tasks
    - View the details of an inspection report
  - Host management
    - Query host types
    - Add host type information
    - Add IDC information
    - Query details about an IDC
    - Delete multiple hosts at a time
    - Query regions
    - Delete an IDC
    - Delete a region
    - Add multiple hosts at a time
    - Delete a host
    - Query details about a host type
    - Add region information
    - Query hosts
    - Query IDCs
    - Query details about a host
    - Query details about a region
    - Delete a host type
  - Alerts
    - Call an alert API
    - Alert events
      - Query alert events
      - Query the alert event list
    - Alert notifications
      - Query alert notifications
  - Monitoring
    - Query monitoring data by tag
    - Query monitoring data
    - Query the description of a monitoring metric
- Information Collection Reference
  - Data Disk Full
    - Collect information about the disk space occupied by temporary files of a tenant
    - Collect incremental data generated during cluster compactions
    - Collect information about sizes of data of different versions in major SSTables
    - Collect information about the macroblock utilization of nodes
    - Collect the data disk usage information of nodes in a cluster
  - CPU Exceptions
    - Collect information about threads with high CPU utilization in an observer process
    - Collect information about processes with high CPU utilization on a cluster node
  - Major Compaction Exceptions
    - Collect the last-one-day records of major compaction events scheduled by RootService
    - Collect major compaction parameter settings
    - Collect diagnostic information about major compactions
    - Collect the checksum information about tablets
    - Collect information about the major compaction status of zones of a cluster
    - Collect the major compaction time
    - Collect RootService task records
    - Collect the checksum information about columns
    - Collect information about the ongoing major compaction in a cluster
    - Collect suggestions provided based on historical major compactions
    - Collect information about DAG warnings in OceanBase Database
  - Cluster Exceptions
    - Collect connectivity information of the sys tenant
    - Collect information about the core dump file of the observer process
    - Collect host logs containing the CRASH ERROR keyword
    - Collect obstack information on a cluster node
    - Collect information about bad disks
    - Collect information about OBServer nodes in a cluster
  - OCP Agent Exceptions
    - Collect panic logs of the mgragent process
    - Collect information about goroutines of the agent processes
    - Collect panic logs of the monagent process
  - Memory Exceptions
    - Collect memory allocation sampling data of OBServer nodes
    - Collect KV cache information of a tenant
    - Collect memory leakage detection information
    - Collect MemStore information of a tenant
    - Collect information about modules with highest memory usage
  - Other Tenants Exceptions
    - Collect host logs containing the dump tenant info keyword
    - Collect host logs containing the dump tenant info keyword
    - Collect host logs containing the dump tenant disk usage keyword
  - Host Exceptions
    - Collect host information by running the df -h command
    - Collect logs from the /var/log/messages directory of a host
- Error codes reference
  - OCP error codes
  - OBServer error codes
    - Oracle mode
      - OBE-00000 to OBE-00999
      - OBE-20000 to OBE-29999
      - Overview
      - OBE-10000 to OBE-19999
      - OBE-30000 to OBE-49999
      - OBE-02000 to OBE-04999
      - PLS-00000 to PLS-00999
      - OBE-50000 to OBE-99999
      - OBE-01500 to OBE-01999
      - OBE-05000 to OBE-10000
      - OBE-01000 to OBE-01499
    - MySQL mode
      - 10000 to 12000
      - 4000 to 4499
      - 4500 to 4999
      - 6000 to 6999
      - 7000 to 7999
      - 9000 to 9499
      - 5000 to 5999
      - 9500 to 9999
      - 8000 to 8999
      - 22998, 30926, 38104, and 38105
      - Overview
      - 0001 to 3999
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
- AWS S3 protocol
- Install and configure OCI
- Component listening port list
- Processes
- OCP background tasks
- Modify the log stream downgrade control time
- Tables managed by the daemon
Release Notes
- V4.3
  - OCP V4.3.4
  - OCP V4.3.1
  - OCP V4.3.0
  - OCP V4.3.5
  - OCP V4.3.3
  - OCP V4.3.2

Download PDF

Document Feedback

Restart a faulty OBServer node

Last Updated：2026-04-16 03:36:04 Updated

This topic describes how to restart an OBServer node.

Prerequisites

Make sure that you have the following permissions:
- Resource Permissions: Cluster Maintenance permission
- Menu Permissions: Permission on the Overview menu of Clusters
The target OceanBase cluster is managed in the current OCP cluster.

Otherwise, you need to use the current OCP cluster to take over the OceanBase cluster. For more information, see Take over a cluster.
If the OBServer node to be restarted hosts the only full-featured replica of a tenant, we recommend that you restart the OBServer node during night hours when the business traffic is low.

Procedure

Log on to the OCP console.
In the left-side navigation pane, click Clusters to go to the Clusters page.
In the Clusters list on this page, find the target cluster and click its name to go to the Overview page of the cluster.
In the OBServers list, find the target OBServer node, and then click Restart in the Actions column.
In the dialog box that appears, set the following parameters and click Restart.
- Set Restart Method to Restart or Force Restart.
  - Restart (recommended): Business access to the database is not interrupted.
  - Force Restart: Business access to the database is interrupted and the business will become unavailable.
- Specify whether to initiate a minor compaction before stopping the observer process. By default, this option is selected. A minor compaction prolongs the response time required to stop the observer process, but significantly shortens the time required to restore the OBServer node.
Note

If the OBServer node does not provide services, you can forcibly restart it. Otherwise, we recommend that you do not choose a force restart. In a general restart task, a pre-check is performed before the OBServer node is restarted. The OBServer node will not be restarted if it does not pass the pre-check. This way, your business is not interrupted.
In the dialog box that appears, click View Task to view the progress.

You can also choose System Management > Tasks to view the progress.

When the task enters the Completed state, and the status of the OBServer node is displayed as Running in the OBServers list on the Overview page, the OBServer node is restarted.

Previous topic

Add an OBServer node

Last

Next topic

Stop an OBServer service