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

  • 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
      • Dependencies
      • System requirements
  • Deploy OceanBase Cloud Platform (OCP)
    • Deploy OceanBase Cloud Platform (OCP) Community Edition
      • Installation process
      • Prepare for the installation
      • Overview
      • Post-deployment check
      • Use Docker to deploy OCP
      • Deploy OCP on the GUI
      • Installation planning
        • Host planning
        • Port planning
        • User planning
        • Disk and directory planning
      • Appendix
        • Install Docker
        • Restart OCP
        • FAQ about deployment
        • Uninstall OCP
    • Deploy OceanBase Cloud Platform (OCP) Enterprise Edition
      • Deployment overview
        • Deploy OCP cluster in the High-availability
        • Deploy OCP cluster in the Single-node
      • Prepare the deployment environment
        • Add a server
        • Check the environment
        • Install OAT
      • Deploy OCP
        • Check after deployment
        • Deploy OCP
          • Deploying a high availability of OCP
            • Create MetaDB
            • Initialize system parameters
            • Register an OCP cluster
            • Prepare installation media
            • Install OCP
          • Deploying a single point of OCP
            • Initialize system parameters
            • Install OCP
            • Prepare installation media
            • Create MetaDB
        • Plan resources
          • Planning resources of a high availability OCP
            • MonitorDB resources
            • Host resources
            • MetaDB resources
            • OCP-Server specifications
          • Planning resources of a single node OCP
            • MonitorDB resources
            • OCP-Server specifications
            • Host resources
            • MetaDB resources
      • Deployment FAQ
        • Optimize MonitorDB parameters
        • F5 Big-IP LTM and alert configuration
          • Monitor the OCP service health
          • Connect OBProxy to F5 Big-IP LTM
          • Connect OCP-Console to F5 Big-IP LTM
        • Ubuntu deployment FAQ
        • EulerOS deployment FAQ
        • Client requirements
        • Start and stop OCP
      • Appendix
        • Uninstall OCP
        • Check the NTP offset
  • Upgrade OceanBase Cloud Platform (OCP)
    • Upgrade OceanBase Cloud Platform (OCP) Enterprise Edition
      • Overview
      • Considerations
      • Preparations
      • Appendix
        • Version mapping
        • Change a user's password
      • 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
      • Upgrade OCP
        • Take over OCP
        • Upgrade OCP
    • Upgrade OceanBase Cloud Platform (OCP) Community Edition
      • Post-upgrade check
      • Upgrade OCP on the GUI
      • Upgrade OCP using Docker containers
  • Quick Start
    • Log on to the OCP console
    • Create a user
    • OCP operations
    • Create an OBProxy cluster
    • Create a tenant
    • Create a cluster
    • Add a host
    • Upload a software package
  • Cluster Management
    • Upgrade an OceanBase cluster
    • View the topology of a cluster
    • Overview of cluster tenant management
    • Manage cluster parameter templates
    • Overview
    • Manage clusters
      • Disable automatic detection of deadlocks
      • Restart a cluster
      • Change the password
      • Delete a cluster
      • Take over a cluster
      • View the SQL collection history
      • Stop a cluster
      • Migrate a cluster
      • Disable SQL collection
      • Create a standby cluster
      • Upgrade a standalone centralized database to a distributed cluster
      • Enable automatic detection of deadlocks
      • View the details of a cluster
    • 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
    • Manage zones of a cluster
      • Add a zone
      • Restart a zone
      • Stop a zone
      • Delete a zone
    • Manage Arbitration Service
      • Remove an arbitration service
      • Replace an arbitration service
      • Take over an arbitration service
      • Delete an arbitration service
      • Create an arbitration service
      • Stop an arbitration service
      • Upgrade an arbitration service
      • Start an arbitration service
      • Arbitration service Overview
      • Migrate an arbitration service
      • Restart an arbitration service
      • Add an arbitration service
    • Manage cluster resource
      • View the unit distribution
      • View resource usage
    • Manage cluster parameters
      • Parameter types
      • View parameters
      • View the history of parameter changes
      • Modify parameters
    • Manage major compaction of a cluster
      • Perform a major compaction
      • View details of major compaction
      • Modify the major compaction settings of a cluster
      • View major freeze statistics
    • Create a cluster
      • Create a distributed cluster
      • Create a standalone centralized database
  • Tenant Management
    • Tenant and resource management
    • Create a primary tenant
    • Modify the allowlist of a tenant
    • View OCP resource unit specifications
    • Manage tenant parameter templates
    • Modify zone priorities
    • Manage databases
    • Manage the resources of a tenant
    • Manage unit specifications
    • View tenant overview information
    • Manage tenants
      • Copy a tenant
      • Manage the binlog service for a tenant
      • Lock a tenant
      • Change the password of the sys tenant
      • Configure full link tracking for a tenant
      • View the details of a tenant
      • Create a standby tenant
      • Delete a tenant
    • Manage major compaction under a tenant
      • Perform a major compaction
      • Modify major compaction settings of a tenant
      • Details of tenant major compaction
    • 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 users and permissions under a tenant
      • System privileges in a MySQL tenant
      • Manage users in a MySQL tenant
      • Manage user under an Oracle tenant
        • Create a role under an Oracle tenant
        • Create a user under an Oracle tenant
        • Delete a user under an Oracle tenant
        • User overview under an Oracle tenant
        • Manage roles
        • Manage users
        • Change the password of a user under an Oracle tenant
    • Manage tenant parameters
      • View the parameters
      • Modify a parameter
      • View the parameter modification history
    • Manage replicas of a tenant
      • Edit a tenant replica in a zone
      • Add a replica
      • Delete a tenant replica from a zone
    • Manage topulogy of a tenant
      • View the topology of a tenant
      • View the topology of primary/standby relationships of a tenant
  • OBProxy Management
    • Parameter management
    • Create an OBProxy cluster
    • View details on the OBProxy page
    • Request analysis
    • Client configuration
    • OBProxy parameters descpription
    • OBProxy management overview
    • Manage OBProxy Clusters
      • Manage load balancing
      • Upgrade an OBProxy cluster
      • Migrate an OBProxy cluster
      • Add a connectable OceanBase cluster
      • Delete a connected OceanBase cluster
      • Manage the proxyro account
      • Change the password of the proxyro user
      • Stop or start an ODP cluster
      • Delete an OBProxy cluster
      • Restart an ODP cluster
      • Change the password of the proxysys user
      • View details on the Overview page of an OBProxy cluster
    • Manage OBProxy Servers
      • Stop or start an OBProxy
      • Take over an OBProxy
      • Refresh OBProxy configurations
      • Upgrade an OBProxy
      • Delete an OBProxy
      • Remove an OBProxy
      • Launch an OBProxy
      • Add an OBProxy
      • Restart an OBProxy
  • Binlog Service Management
    • Binlog service overview
    • Create a binlog cluster
    • Manage binlog cluster parameters
    • Manage Binlog Clusters
      • Start and stop a binlog cluster
      • View information about a binlog cluster
      • Restart a binlog cluster
      • Delete a binlog cluster
      • 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 Instance
        • View a binlog instance
        • Manage binlog instance parameters
        • Restart a binlog instance
        • Start and stop a binlog instance
  • Host Management
    • OCP-Agent processes
    • View details of a host
    • Perform host standardization checks
    • Host standardization check items
    • Reinstall OCP Agent
    • View the details of tasks on a host
    • Add a host
    • Modify a host
    • Host management operations
    • Restart OCP-Agent
    • OCP-Agent O&M Script Instructions
    • Remove a host
  • Alert Management
    • Overview
    • Alert-related concepts
    • Manage alert rules
      • Create an alert rule
      • Copy an alert rule
      • View an alert rule
      • Edit an alert rule
      • Export alert rule configurations
      • Alert rule groups
      • Delete an alert rule
    • 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
      • Edit an alert blocking condition
      • Create a blocking condition
      • Delete an alert blocking condition
    • OCP alert template tag
    • Optional monitoring metrics for custom alerts
  • Dashboard Management
    • Manage dashboards
    • Monitoring dashboard overview
    • Manage groups
    • Manage charts
  • Performance Monitoring
    • Use the custom monitoring feature
      • View collection items
      • Overview
      • OCP metrics
      • Manage indicator items
        • Create a metric
        • Manage metrics
      • Manage charts
        • Create a chart
        • Manage charts
    • 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 subscription connection monitoring charts
      • View performance monitoring data of a binlog instance
      • View resource monitoring data of a binlog instance
      • View host resources
      • View host processes
      • View service monitoring data
      • View system monitoring data
      • View performance monitoring
      • Drill-down monitoring
      • Integrate monitoring data to an external time-series system
  • Diagnostics and Tuning
    • 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
    • Transaction Diagnostics
      • Diagnostics Transaction
      • Overview of transaction
      • Diagnose XA transactions and suspended transactions
    • Manage sessions
      • Manage the sessions of a tenant
      • View session statistics
      • View the deadlock history
    • View the Optimization Center page
    • View the capacity center
    • View diagnostics reports
      • Performance report
      • Manage ASH report
  • O&M Management
    • Manage Inspection
      • Inspection
      • Configure inspection items
      • Configure Scheduling Rules
        • Configure a global scheduling rule
        • Configure a scheduling rule for a single object
      • Initiate Inspection
        • Initiate a global inspection
        • Initiate an inspection for a single object
      • View an inspection task
      • Manage Inspection reports
        • View an inspection report
        • Download an inspection report
    • Manage Plans
      • Manage plans
      • Overview
      • View plan execution details
    • Manage Information Collection
      • Download an information collection report
      • Configure information collection items
      • View information collection details
      • Overview
      • Create an information collection task
  • Backup and Recovery
    • Overview
    • Backup and recovery guide
    • Initiate a restore job
    • 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 a 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
      • Create a standby tenant for a primary tenant managed by another OCP cluster
      • 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
  • 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
    • Manage password box
      • Verify a credential
      • Edit a credential
      • Batch operations on credentials
      • Create a credential
      • Import a credential
      • Export a credential
      • Delete a credential
    • Manage users
      • Manage a role
        • Role overview
        • Create a role
        • Copy a role
        • View a role
        • Edit a role
        • Delete a role
        • Default OCP roles
      • Manage a user
        • Logon history
        • Delete a user
        • Users overview
        • Change a user password
        • Create a user
        • Edit a user
        • Copy a user
        • View users
    • Manage tags
      • Overview
      • Delete a tag
      • Edit a tag
      • Create a tag
      • Modify objects bound to a tag
    • View operation records
    • Manage system parameters
      • OCP configuration parameters
      • Modify system parameters
      • View system parameters
    • Manage tasks
    • User center management
      • Log off the OCP console
      • Configure personal information
      • Change your logon password
  • 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
    • Check the availability of an auto-increment column
    • 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
    • Perform an inspection in OCP to detect potential risks in an OceanBase cluster
    • Take over OBProxies
    • Configure custom monitoring
    • Send alert messages to a DingTalk group
    • Use the backup and restore module to restore data
    • Monitor the business load of OceanBase Database
    • Upgrade an OceanBase cluster
    • 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
    • Scale in an OceanBase cluster and scale down an OceanBase Database tenant
    • Scale in an OBProxy cluster
    • Expand the high availability of OceanBase clusters and tenants
    • Scale out an OBProxy cluster
    • Send alert messages to a WeChat Enterprise group
    • Move out an OBProxy cluster
    • Back up an OceanBase cluster
    • Migrate a resource unit from an OceanBase Database tenant
    • Delete an OBProxy
    • Perform a failover
    • Decouple a standby tenant from the primary tenant
    • Perform a switchover between primary and standby OceanBase Database tenants in a scenario with two IDCs
    • Use the arbitration service of OceanBase Database to achieve HA 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_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
      • 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
      • OceanBase Database tenant
        • Number of XA statements
        • TPS
        • Cache size
        • I/O Throughput
        • Request waiting queue time consuming
        • Number of transaction logs
        • Partitions
        • Frozen MemStores
        • IOPS
        • Transaction log volume
        • SQL execution plan category
        • Frontend workload metrics
        • Transaction response time
        • Tenant CPU cost
        • Backend wait event metrics
        • Request waiting queue
        • Response time
        • Time consumed by lock waits
        • Rpc package rt
        • Metrics for the SQL execution phase
        • Cursors
        • Request queue size
        • Wait events
        • Tenant thread usage
        • QPS
        • Sessions
        • RPC packet throughput
        • Time consumed by transaction logs
        • memroy usage pecent
        • Cache hit rates
        • MemStore usage
        • SQL execution plan time
        • Clog synchronization delay
        • Lock waits
        • DB time metrics
        • MemStore
        • TPS
        • Number of XA transactions
        • Transaction table read request hits
        • Average execution duration of XA statements
        • Metrics related to time consumption of wait events
        • Number of cache requests
        • IO time-consuming
        • Transaction response time details
      • OBProxy cluster
        • TPS
        • QPS
        • Client connections
        • Server connections
        • Memory for the obproxy process
        • CPU utilization of the obproxy process
        • Number of file descriptors for the obproxy process
        • Number of threads in the obproxy process
        • Average bytes in a network request or response
        • 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
      • Binlog Service
        • memory used
        • network bytes
        • disk ratio
        • Sending Delay
        • FD count
        • disk used
        • Associate RPS
        • Binlog Disk Write Rate
        • Binlog RPS
        • memory
        • Network Traffic
        • Binlog Delay
        • CPU
    • 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
      • 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
        • 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
        • 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
        • Revoke global privileges of a user
        • 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
        • Change object privileges of a user
        • Change object privileges of a role
        • Revoke object privileges of a role
      • System-management
        • Health examination
          • Query the basic information of an OCP application
          • Query OCP server time
          • Query OCP application status
        • Operation Audit
          • Query event history
        • 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 the operator structure of an execution plan
        • Query SQL text
        • Query the performance indicator trend of an execution plan
        • Query performance indicators of an execution plan
        • Query a performance report
        • Query snapshots
        • Generate a performance report
        • Query the list of slow SQL statements
      • 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
        • Delete the backup strategy of a cluster
        • Initiate tenant recovery
        • Clear added restore resources
        • Query recovery tasks of a cluster
        • 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
        • Parse cluster backup data
        • Query data backup tasks of a cluster
        • Add restore resources
        • Create a backup strategy for a cluster
        • Immediately back up a cluster
        • Preview a restore task
        • Query log backup tasks of a cluster
        • Initiate a data backup for a tenant
        • Create a backup strategy for a tenant
        • Delete the backup strategy of a tenant
        • View the data backup tasks of a tenant
        • View the log backup tasks of a tenant
        • View restore tasks
        • Parse the backup information of a tenant
        • Query the backup strategy of a tenant
        • Modify the backup strategy of a tenant
      • OBProxy management
        • Update configurations of an OBProxy cluster
        • Upgrade an OBProxy
        • Remove a connectable OceanBase cluster from an OBProxy cluster
        • Create an OBProxy cluster
        • Query the description information of the OBProxy parameters
        • Query details about an OBProxy cluster
        • Add an OBProxy
        • Delete an OBProxy
        • Take over an OBProxy
        • Add a connectable OceanBase cluster for an OBProxy cluster
        • Query parameters of an OBProxy cluster
        • Delete an OBProxy cluster
        • Query OBProxy clusters
        • Restart an OBProxy
      • Cluster management
        • Query OceanBase 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 description information of the OceanBase cluster parameters
        • Query parameters of an OceanBase cluster
        • Modify parameters of an OceanBase cluster
        • Query the list of OBServers in an OceanBase cluster
        • Query the list of OBServers in a zone
        • Perform a switchover pre-check
        • Perform a failover pre-check
        • Perform a switchover
        • Perform a failover
        • Obtain resource statistics of an OceanBase cluster
        • Obtain resource statistics of all OBServer nodes in a cluster
        • Query the list of resource units in an OceanBase cluster
      • Tenant management
        • Create a tenant
        • Modify a replica of a tenant
        • Modify parameters of a tenant
        • Query tenants of a cluster
        • Obtain a list of unit specifications
        • Delete a unit from a tenant
        • Add a replica for a tenant
        • Create a resource unit specification
        • Unlock a tenant
        • 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
        • Query details about a tenant
        • Modify the whitelist of a tenant
        • Lock a tenant
        • Modify zone priorities of a tenant
        • Query units of a tenant
        • Delete a tenant
      • Inspection
        • Query all inspection tasks
        • Query inspection objects
        • View the details of an inspection report
        • Initiate an inspection
      • 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 the alert event list
          • Query alert events
        • Alert notifications
          • Query alert notifications
      • Monitoring
        • Query monitoring data by tag
        • Query monitoring data
        • Query the description information of monitoring metrics
  • 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
    • OCP error codes
    • Tables managed by the daemon
  • Release Notes
    • V4.3
      • OCP V4.3.0
      • OCP V4.3.1

Download PDF

Document Overview What is OceanBase Cloud Platform? Differences between the features of OCP Enterprise Edition and OCP Community Edition System architecture Features Dependencies System requirements Installation process Prepare for the installation Overview Post-deployment check Use Docker to deploy OCP Deploy OCP on the GUI Overview Considerations Preparations Post-upgrade check Upgrade OCP on the GUI Upgrade OCP using Docker containers Log on to the OCP console Create a user OCP operations Create an OBProxy cluster Create a tenant Create a cluster Add a host Upload a software package Upgrade an OceanBase cluster View the topology of a cluster Overview of cluster tenant management Manage cluster parameter templates Overview Disable automatic detection of deadlocks Restart a cluster Change the password Delete a cluster Take over a cluster View the SQL collection history Stop a cluster Migrate a cluster Disable SQL collection Create a standby cluster Upgrade a standalone centralized database to a distributed cluster Enable automatic detection of deadlocks View the details 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 OBServerDelete an OBServer Add a zone Restart a zone Stop a zone Delete a zone Remove an arbitration service Replace an arbitration service Take over an arbitration service Delete an arbitration service Create an arbitration service Stop an arbitration service Upgrade an arbitration service Start an arbitration service Arbitration service Overview Migrate an arbitration service Restart an arbitration service Add an arbitration service View the unit distribution View resource usage Parameter types View parameters View the history of parameter changes Modify parameters Perform a major compaction View details of major compaction Modify the major compaction settings of a cluster View major freeze statistics Create a distributed cluster Create a standalone centralized database Tenant and resource management Create a primary tenant Modify the allowlist of a tenantView OCP resource unit specifications Manage tenant parameter templates Modify zone priorities Manage databases Manage the resources of a tenant Manage unit specifications View tenant overview information Copy a tenant Manage the binlog service for a tenantLock a tenant Change the password of the sys tenant Configure full link tracking for a tenant View the details of a tenant Create a standby tenant Delete a tenant Perform a major compaction Modify major compaction settings of a tenant
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.3.1
iconOceanBase Cloud Platform
V 4.3.1
  • 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

Upgrade OCP

Last Updated:2026-04-14 07:46:03  Updated
share
What is on this page
Prerequisites
Procedure

folded

share

You can upgrade OceanBase Cloud Platform (OCP) V3.2.4 and later to V4.2.0 through the GUI of OceanBase Admin Toolkit (OAT).

Prerequisites

OAT has taken over the target OCP.

Procedure

  1. Log on to the OAT console.

  2. In the left-side navigation pane, choose Product Service > Products.

  3. On the OCP tab of the Product Management page, find the target OCP and click its name in the Name column to go to the details page.

    Note

    If there are too many OCPs, you can also search for the target OCP by product name in the upper-right corner of the page.

  4. In the upper-right corner of the details page, click Upgrade.

    1

  5. In the Upgrade dialog box, enter the required information.

    The following table describes the related fields.

    Field Description
    Upgrade Mode The upgrade method. At present, OAT only supports Upgrade with Services Stopped, which is suitable for products without business continuity requirements. In this upgrade mode, OAT stops the services of the old version of OCP, which cannot provide external services.
    Select an image file for the upgrade The image file of the target version.
    Username The username of OCP. This field is not displayed if the source version is OCP V4.0.1 or later.
    Password The password of OCP. This field is not displayed if the source version is OCP V4.0.1 or later.

    2

  6. Click OK.

  7. After an upgrade task is submitted, choose System and Security > Tasks. On the page that appears, click the name of the task to view its details.

    3

  8. Log on to the OCP console. If the page of OCP appears, the major components in the system architecture of OCP have been upgraded. Some time-consuming tasks continue to run in the background.

    You need to verify the upgrade from the following aspects:

    1. In the task list, check whether the task for upgrading OCP-Agent is properly running.

    2. Open the bootstrap.log file of OCP-Server, which is located in /home/admin/logs/ocp by default, and find the tasks marked as DELAYED, such as ALTER_TABLES_DELAYED and MIGRATIONS_DELAYED. Then, check whether the tasks are marked as END. The BEGIN and END marks appear in pairs.

    3. If the upgrade fails, open the ocp.log file of OCP-Server, which is located in /home/admin/logs/ocp by default, and check for unexpected errors in logs with the keyword "BootstrapRunListener" or "DataSourceInterceptor". Such logs are generated after ocp-bootstrap registers with a listener, which is used to block Spring bean initialization events. If an unexpected error is reported, contact OCP Technical Support.

    4

Previous topic

Take over OCP
Last

Next topic

Verify the cluster feature
Next
What is on this page
Prerequisites
Procedure