OceanBase logo

OceanBase

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

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

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

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

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

About OceanBase

Partner

Trust Center

Contact Us

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

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

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

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

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

Practical guides for utilizing OceanBase more effectively and conveniently

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

About OceanBase

Partner

Trust Center

Contact Us

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

OceanBase Cloud Platform

V4.0.0Enterprise Edition

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

Download PDF

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

The Unified Distributed Database for the AI Era.

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

© OceanBase 2026. All rights reserved

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

Cluster backup and recovery

Last Updated:2023-08-15 02:30:55  Updated
share
What is on this page
Procedure

folded

share

Cluster backup and recovery

On the cluster backup and recovery page, you can view the basic information, details, and strategies of backup and recovery of the current cluster.

Procedure

  1. Log on to the OceanBase Cloud Platform (OCP) console.

  2. In the left-side navigation pane, click Clusters . The cluster overview page appears.

  3. Find the target cluster in the Clusters list and click its name to go to the Overview page of the cluster.

  4. In the left-navigation pane, click Backup & Recovery .

    On the Backup & Recovery page, you can:

    • Click Initiate Recovery to recover the cluster. For more information, see Initiate a recovery.

    • Click Back up Now to back up the cluster. For more information, see Back up now.

    • If no backup strategy is created for the cluster, click New Backup Strategy to create a backup strategy for the cluster. For more information, see Create a backup strategy.

    • If a backup strategy has been created for the cluster, click ... in the upper-right corner and select Modify Backup Strategy to modify the backup strategy. For information about the backup strategy parameters, see Create a backup strategy.

    • If a backup strategy has been created for the cluster, click in the upper-right corner and select Delete Backup Strategy to delete the backup strategy.

    • If a backup strategy has been created for the cluster, click Pause to pause the scheduling of automatic backup tasks for the cluster.

    • View the basic information of the cluster in fields such as Status, Backup Method, Backup File, Last Data Backup Time, Log Backup Checkpoint, Log Delay, Scheduling History of Data Backup , and Scheduling History of Second Log Backup .

      1

      Parameter Description
      Status The backup status. Valid values: Pending Backup Scheduling , In Progress , and No Backup Strategy .
      Backup Method The backup method. This field is displayed only when a backup strategy has been created for the cluster. Valid values: Physical Backup and Logical Backup .
      Backup File The size of the backup file. This field is displayed only when a backup strategy has been created for the cluster.
      Last Data Backup The time of the last backup.
      Log Backup Checkpoint The latest time of log backup.
      Log Delay The delay between the backup data and the actual data. This field is displayed only when a backup strategy has been created for the cluster.
      Scheduling History of Data Backup Click View to view the scheduling history of backup tasks.
      Scheduling History of Second Log Backup Click View to view the scheduling history of second log backup tasks.
  5. View the backup details about the cluster.

    • If a backup strategy has been created for the cluster, you can view Available Recovery Period . You can select a tenant from the drop-down list to view its backup information displayed by week, and confirm the available point in time for recovery. If you do not select a tenant, the displayed available recovery period encompasses the available points in time for recovery of all tenants in the cluster.

      2

    • View alerts: You can filter alerts by time range. The total number of alerts in the specified time range is displayed in the ring chart on the left, and the table on the right displays the following information about the alerts: ID, Alert Object, Alert Type, Generated At, Recovered At, Last Generated At , and Status . You can click the ID of an alert to view the details of the alert.

      3

    • View data backup tasks: The table on the Data Backup Tasks tab containsthe following columns: ID, Tenant, Data Backup Method, Backup Set ID, Backup Task Source, Start Time, End Time, Status, Second Backup, and Actions .

      3

    • View log backup tasks: The table on the Log Backup Tasks tab contains the following columns: Backup Method, Host IP Address, Last Backed up At, Latency (s), Storage Directory , Started Time , Status , and Actions . The Actions column provides options for you to start or stop a log backup task.

      3

    • View second data backup tasks: The table on the Second Data Backup tab contains the following columns: ID, Tenant, Backup Set ID, Start Time, End Time, Storage Directory , and Status .

      4

    • View second log backup tasks: The table on the Second Log Backup tab contains the following columns: Last Backed up At, Storage Directory , Start Time , and Status .

      4

    • View recovery tasks: The table on the Recovery Tasks tab contains the following columns: ID, Backup Cluster, Backup Tenant, Destination Cluster, Destination Tenant, Start Time, End Time , and Status . You can task actions on failed recovery tasks.

      4

    • On the Cleanup Tasks tab, you can filter cleanup tasks by time range. The table on this tab contains the following columns: ID, Cluster, Start Time, End Time , and Status .

      Note

      The Cleanup Tasks tab is displayed only for clusters that support logical backup. Physical backups are automatically cleaned up by OceanBase Database and are not displayed in OCP.

    • View the backup storage trends: You can select a time range to view the backup storage trends from the perspective of Total Volume, Data Backup , and Log Backup .

      5

  6. If a backup strategy has been created for the cluster, you can click the Backup Strategy tab to view the backup scheduling strategy for the cluster.

    The backup scheduling strategy includes the backup method, backup storage, backup scheduling, cleanup scheduling configuration for expired backups, alert threshold, scheduling configuration for second backup, and storage configuration. 6

Previous topic

Perform a major compaction
Last

Next topic

View parameters
Next
What is on this page
Procedure