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

  • Document Overview
  • Product Introduction
    • What is OceanBase Cloud Platform?
    • Differences between the features of OCP Enterprise Edition and OCP Community Edition
    • System architecture
    • Features
    • Limits
      • System requirements
      • Dependencies
  • Deploy OceanBase Cloud Platform (OCP)
    • Deploy OceanBase Cloud Platform (OCP) Enterprise Edition
      • Deployment overview
        • Deploy OCP cluster in the Single-node
        • Deploy OCP cluster in the High-availability
      • Prepare the deployment environment
        • Install OAT
        • Add a server
        • Check the environment
      • Deploy OCP
        • Plan resources
          • Planning resources of a single node OCP
            • OCP-Server specifications
            • MetaDB resources
            • MonitorDB resources
            • Host resources
          • Planning resources of a high availability OCP
            • OCP-Server specifications
            • MetaDB resources
            • MonitorDB resources
            • Host resources
        • Deploy OCP
          • Deploying a single point of OCP
            • Prepare installation media
            • Create MetaDB
            • Install OCP
            • Initialize system parameters
          • Deploying a high availability of OCP
            • Prepare installation media
            • Create MetaDB
            • Install OCP
            • Register an OCP cluster
            • Initialize system parameters
        • Check after deployment
      • Deployment FAQ
        • Optimize MonitorDB parameters
        • F5 Big-IP LTM and alert configuration
          • Connect OBProxy to F5 Big-IP LTM
          • Connect OCP-Console to F5 Big-IP LTM
          • Monitor the OCP service health
        • Ubuntu deployment FAQ
        • EulerOS deployment FAQ
        • Client requirements
        • Start and stop OCP
      • Appendix
        • Uninstall OCP
        • 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
      • Enable automatic detection of deadlocks
      • Disable automatic detection of deadlocks
      • Manage O&M configuration
        • Overview
        • Manage parameters
        • View the parameter modification history
      • Manage CPU binding configurations
    • Manage Arbitration Service
      • Arbitration service Overview
      • Create an arbitration service
      • Take over an arbitration service
      • Stop an arbitration service
      • Start an arbitration service
      • Upgrade an arbitration service
      • Restart an arbitration service
      • Migrate an arbitration service
      • Delete an arbitration service
      • Add an arbitration service
      • Replace an arbitration service
      • Remove an arbitration service
    • Manage zones of a cluster
      • Add a zone
      • 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
    • Manage cluster parameter templates
    • Manage cluster parameters
      • Parameter types
      • View parameters
      • Modify parameters
      • View the history of parameter changes
  • Tenant Management
    • Tenant and resource management
    • View tenant overview information
    • Create a primary tenant
    • Manage unit specifications
    • View OCP resource unit specifications
    • 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 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
    • Manage statistical information
      • Overview
      • Collect statistics
      • Manage statistics collection tasks
    • Manage tenant parameter templates
    • Manage tenant parameters
      • View the parameters
      • Modify a parameter
      • View the parameter modification history
  • OBProxy Management
    • OBProxy management overview
    • View details on the OBProxy page
    • Create an OBProxy cluster
    • Manage OBProxy Clusters
      • View details on the Overview page of an OBProxy cluster
      • Add a connectable OceanBase cluster
      • Manage load balancing
      • Change the password of the proxysys user
      • Change the password of the proxyro user
      • 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
    • OBProxy parameters descpription
  • Binlog Service Management
    • Binlog service overview
    • Create a binlog cluster
    • Manage Binlog Clusters
      • View information about 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
  • 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
    • Optional monitoring metrics for custom alerts
    • OCP alert template tag
    • View alert events
    • Manage alert push
      • Create an alert push
      • View an alert push
      • Edit an alert push
      • Delete an alert push
    • Manage blocking conditions
      • Create a blocking condition
      • Edit an alert blocking condition
      • Delete an alert blocking condition
    • 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
  • Dashboard Management
    • Manage dashboards
    • Monitoring dashboard overview
    • Manage groups
    • Manage charts
  • Performance Monitoring
    • Use the custom monitoring feature
      • Overview
      • View collection items
      • Manage indicator items
        • Create a metric
        • Manage metrics
      • Manage charts
        • Create a chart
        • Manage charts
      • OCP metrics
    • Manage monitoring
      • Overview
      • View database performance data
      • View host performance data
      • View OBServer node performance data
      • View the performance and SQL monitoring data of a tenant
      • View transaction performance data
      • View storage and cache monitoring data
      • View database object monitoring data
      • View OBKV-Table monitoring data
      • View OBKV-HBase 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
  • Diagnostics and Tuning
    • View the capacity center
    • View the Optimization Center page
    • View diagnostics reports
      • Performance report
      • Manage ASH reports
    • SQL Diagnostics
      • Diagnose suspicious SQL statements
      • Diagnose slow SQL statements
      • View the OceanBase Autonomy Service page
      • Diagnose top SQL statements
      • Diagnose high-risk SQL statements
      • View outlines
      • Parameters related to SQL performance diagnostics
      • View SQL request analysis
      • View details of an SQL statement
      • Diagnose parallel SQL statements
      • View Comparison of Top SQL Statements
      • Diagnose new SQL statements
      • View the SQL collection enable/disable history
      • SQL Diagnostics Introduction
        • SQL statement execution statistics
        • SQL execution plans
        • SQL diagnostics overview
    • Manage sessions
      • Manage the sessions of a tenant
      • View session statistics
      • # View row lock analytics
      • View row lock analytics
    • Transaction Diagnostics
      • Diagnose transactions
      • Overview of transaction
      • Diagnose XA transactions and suspended transactions
  • O&M Management
    • Manage Inspection
      • Inspection
      • Configure inspection items
      • View an inspection task
      • Manage Inspection reports
        • View an inspection report
        • Download an inspection report
      • 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
    • 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 restore guide
    • Initiate a restore task
    • Overview
    • View restore tasks
    • Manage backup and recovery service
      • Stop a service on a node
      • Copy a service
      • Uninstall a service on a node
      • Add a node
      • Upgrade the version of a service
      • Restart a service on a node
      • Delete a service
      • View services
      • Install a service
      • Update service configurations
      • View O\&M tasks
    • Manage backup tasks
      • View second backup tasks
      • View backup tasks
    • Regular backup
      • Manage cluster-level backup strategy
        • View a cluster-level backup stategy
        • Create a cluster-level backup strategy
        • Modify a cluster-level backup strategy
        • Delete a cluster-level backup strategy
        • Pause backup scheduling
      • Manage tenant-level backup strategy
        • Pause backup scheduling
        • Create a tenant-level backup strategy
        • View a tenant-level backup stategy
        • Delete a tenant-level backup strategy
        • Modify a tenant-level backup strategy
    • Regular recovery
      • View sampling strategies
      • View sampling tasks
      • Create a sampling strategy for recovery
    • Backup now
      • Back up 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
    • View operation records
    • Manage tasks
    • Manage users
      • Manage a role
        • Create a role
        • Delete a role
        • Edit a role
        • View a role
        • Default OCP roles
        • Role overview
        • Copy a role
      • 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
    • 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 system parameters
      • OCP configuration parameters
      • Modify system parameters
      • View system 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
      • 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 to a DingTalk group
    • Send alert messages through email
    • Back up an OceanBase 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
    • Migrate a resource unit from an OceanBase Database tenant
    • 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 out an OBProxy cluster
    • 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
    • Expand the high availability of OceanBase clusters and tenants
    • Use the backup and restore module to restore data
    • Move out an OBProxy cluster
    • 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
    • Send alert messages to a WeChat Enterprise group
    • 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
    • Scale in an OceanBase cluster and scale down an OceanBase Database tenant
  • Reference Guide
    • Alarm reference
      • Overview
      • Application alerts
        • ob_host_monitordb_disconnected
        • base_backup_too_long_time_no_one_success_task
        • backup_process_dead
        • odp_sql_query_slow
        • ob_cluster_inspection_not_passed
        • upgrade_ocp_agent_failed
        • monitor_exporter_unavailable
        • ob_host_tcp_retrans_percent_over_threshold
        • odp_instance_compress_failed
        • backup_storage_capacity_timeout_or_interrupted
        • ob_host_invalid_disk_exists
        • ocp_remote_server_time_diff_too_large
        • host_agent_open_fd_count_over_threshold
        • ic_server_connect_failed Inter-Connector
        • Host log alerts
        • host_agent_goroutine_count_over_threshold
        • obagent_dead
        • host_ntp_service_not_exist
        • host_ntp_offset_too_large
        • backup_storage_capacity_over_threshold
        • base_backup_timeout
        • partition_create_failed
        • host_disk_readonly
        • ocp_http_request_timeout
        • ocp_collect_metric_failure_rate_high
        • host_agent_res_memory_over_threshold
        • ob_host_net_recv_percent_over_threshold
        • vpc_connect_failed
        • odp_sql_execute_failed
        • ob_host_ssd_wear_indicator_over_threshold
        • mgragent_process_stop
        • host_agent_version_not_same
        • agentd_process_stop
        • base_backup_fail
        • ocp_alarm_detect_timeout
        • ob_host_net_send_percent_over_threshold
        • ob_host_cpu_percent_over_threshold
        • monagent_process_stop
        • ocp_meta_db_disconnected
        • ocp_contingency_failed
        • system_obproxy_unavailable
        • node_load1_peak
        • base_secondary_backup_fail
        • ob_host_mem_percent_over_threshold
        • backup_storage_capacity_retry_times_exceeded
        • odp_instance_expanse_failed
        • inc_backup_delay
        • ocp_http_request_too_many_errors_occur
        • ob_cluster_recyclebin_disk_used_over_threshold
        • host_unavailable
      • OceanBase alerts
        • ob_cluster_merge_timeout
        • ob_tenant_expired_trans_exist
        • ob_cluster_rs_not_same
        • standby_tenant_sync_delay_too_long
        • ob_cluster_status_check_failed
        • ob_cpu_percent_over_threshold
        • observer_process_stop
        • ob_cluster_operation_info
        • obproxy_core_dump
        • ob_cannot_connected
        • ob_cluster_frozen_version_delta_over_threshold
        • tenant_active_memstore_percent_over_threshold
        • refresh_location_cache_failed_by_metric
        • ob_server_sstable_percent_over_threshold
        • ob_host_task_timeout
        • oas_anomaly_sql_from_anomaly_event_analysis_cpu_percent_high
        • ob_tenant_long_trans_exist
        • ob_tenant_compaction_error
        • obproxy_client_connections_usage_over_threshold
        • OceanBase log alerts
        • obproxy_process_dead
        • ob_host_load1_per_cpu_over_threshold
        • ob_cluster_no_frozen
        • ob_host_operation
        • ob_host_install_disk_percent_over_threshold
        • obproxy_cannot_connected
        • host_operation
        • oas_anomaly_sql_from_anomaly_event_analysis_plan_changed
        • ob_tenant_partition_replica_absent
        • ob_tenant_no_frozen
        • ob_tenant500_storage_short_meta_mem_hold_high
        • ob_cpu_assigned_percent_over_threshold
        • ob_tenant_exists_expired_xa_trans
        • ob_tenant_large_trans_exist
        • ob_cluster_merge_error
        • ob_cluster_sync_failed
        • os_observer_not_exist
        • refresh_location_cache_failed
        • ob_tenant_cpu_usage_over_threshold
        • ob_tenant_active_session_count_over_threshold
        • ob_tenant_log_disk_usage_high
        • ob_tenant_no_compaction
        • ob_cluster_no_merge
        • standby_tenant_sync_status_error
        • ob_cluster_sync_delay_time_too_long
        • ob_tenant_request_queue_over_threshold
        • ob_host_data_disk_percent_over_threshold
        • ob_tenant_operation_info
        • ob_mem_assigned_percent_over_threshold
        • obproxy_process_stop
        • ob_tenant_expired_trans_exist
        • agent_process_count_abnormal
        • tenant_memstore_percent_over_threshold
        • ob_host_partition_count_over_threshold
        • oas_anomaly_sql_from_sql_inspection_perf_degradation
        • ob_server_cannot_connect_arbitration
        • ob_tenant_log_stream_degraded
        • obproxyd_process_dead
        • ob_host_active_session_count_over_threshold
        • oas_anomaly_sql_from_anomaly_event_analysis_perf_degradation
        • ob_host_disk_readonly
        • obproxy_host_operation
        • obproxy_cluster_operation
        • ob_cluster_active_session_count_over_threshold
        • ob_host_log_disk_percent_over_threshold
        • ob_host_connection_percent_over_threshold
        • ob_tenant_partition_leader_absent
        • oas_anomaly_sql_from_sql_inspection_plan_changed
        • ob_tenant500_mem_hold_percent_over_threshold
        • arbitration_service_unavailable
        • ob_tenant_long_trans_exist
        • obproxyd_process_stop
        • ob_cluster_exists_index_fail_table
        • same_alarm_rule_detect_too_many_targets
        • tenant_cpu_percent_over_threshold
        • ob_cluster_exists_inactive_server
        • ob_tenant_task_timeout
        • ob_tenant_slow_sql_exists
        • ob_tenant500_mem_hold_over_threshold
      • OAS alerts
        • node_memory_peak
        • os_nic_1000m_full
        • os_tsar_cpu_util_hwm
        • os_observer_fd_usage
        • os_tsar_traffic_error
        • os_tsar_cpu_util_full
        • os_kernel_ntp_delay
        • node_file_datalog1_usage
        • os_home_file_usage
        • os_tsar_nvme_ioawait
        • os_tsar_cpu_sys_abnormal
        • os_tsar_traffic_overload
        • os_tsar_traffic_drop
        • os_tsar_sda_ioawait
        • os_kernel_io_hang
        • sql_audit_collect_lost_percent_over_threshold
        • node_file_inode_usage
        • node_file_root_usage
        • node_file_data1_usage
        • os_kernel_ntp_down
        • os_nic_1000m_hwm
        • os_cpu_irq_error
        • os_observer_core_dump
      • Appendix
        • Network troubleshooting
        • Execute the alert clearance plan
        • Exception handling for OceanBase cluster compaction
        • Apply throttling to an OceanBase cluster
    • Metric reference
      • Overview of metrics
      • Monitoring metrics list
      • OceanBase Database tenant
        • Frontend workload metrics
        • Number of XA statements
        • # Average number of statement lines processed (OBKV-Table)
        • TPS
        • Cache size
        • IO time-consuming
        • I/O Throughput
        • SQL execution plan time
        • Number of transaction logs
        • Partitions
        • Transaction response time details
        • Frozen MemStores
        • Objects
        • IOPS
        • # Data disk
        • SQL execution plan category
        • Transaction table read request hits
        • Transaction response time
        • Tenant CPU cost
        • Metrics related to time consumption of wait events
        • Background workload metrics
        • Number of cache requests
        • # Response time (OBKV-Table)
        • Request waiting queue
        • Response time (SQL mode)
        • MemStore
        • Rpc package rt
        • # Average number of statement lines processed (OBKV-HBase)
        • Metrics for the SQL execution phase
        • # QPS (OBKV_Hbase)
        • # Log disk
        • Cursors
        • # Response time (OBKV-HBase)
        • Request queue size
        • Wait events
        • Tenant thread usage
        • QPS
        • Sessions
        • TPS
        • Time consumed by transaction logs
        • memroy usage pecent
        • PX worker thread usage
        • Cache hit rates
        • MemStore usage
        • # QPS (OBKV-Table)
        • Number of XA transactions
        • Clog synchronization delay
        • Lock waits
        • DB time metrics
        • Request waiting queue time consuming
        • Average execution duration of XA statements
        • Time consumed by lock waits
        • Transaction log volume
        • RPC packet throughput
      • OBProxy cluster
        • Memory for the obproxy process
        • Client connections
        • Number of threads in the obproxy process
        • Number of file descriptors for the obproxy process
        • TPS
        • Server connections
        • Net bytes
        • QPS
        • OBProxy CPU usage
        • Log error
        • Route table queries
        • 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
        • 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
        • 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
        • Delete multiple OBServers at a time
        • Stop an OceanBase cluster
        • # Take over an OceanBase cluster
        • Create a zone for an OceanBase cluster
        • Restart a zone in an OceanBase cluster
        • Start a zone in an OceanBase cluster
        • Query the description information of the OceanBase cluster parameters
        • Add an OBServer
        • Perform a switchover pre-check
        • Obtain resource statistics of an OceanBase cluster
        • Upgrade an OceanBase cluster
        • Perform a switchover
        • Restart an OceanBase cluster
        • Query zones of an OceanBase cluster
        • Start an OBServer
        • Create an OceanBase cluster
        • # Move out an OceanBase cluster
        • Stop a zone in an OceanBase cluster
        • Modify parameters of an OceanBase cluster
        • Query the list of OBServers in an OceanBase cluster
        • Obtain resource statistics of all OBServer nodes in a cluster
        • Query the list of OBServers in a zone
        • Query parameters of an OceanBase cluster
        • Perform a failover
        • # Perform a takeover precheck on an OceanBase cluster
        • Start an OceanBase cluster
        • Delete a zone from an OceanBase cluster
        • Query the list of resource units in an OceanBase cluster
        • Change the password of an OceanBase cluster
        • Stop an OBServer
        • Query OceanBase clusters
        • Perform a failover pre-check
        • Restart an OBServer
        • Replace an OBServer
        • Delete an OceanBase cluster
      • 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 whitelist 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 information of monitoring metrics
    • Error codes reference
      • OCP error codes
      • OBServer error codes
        • Oracle mode
          • ORA-10000 to ORA-19999
          • Overview
          • ORA-02000 to ORA-04999
          • ORA-50000 to ORA-99999
          • ORA-05000 to ORA-10000
          • ORA-01000 to ORA-01499
          • ORA-00000 to ORA-00999
          • ORA-20000 to ORA-29999
          • PLS-00000 to PLS-00999
          • ORA-01500 to ORA-01999
          • ORA-30000 to ORA-49999
        • 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
    • 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
  • 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
    • Tables managed by the daemon
  • Release Notes
    • V4.3
      • OCP V4.3.1
      • OCP V4.3.0
      • OCP V4.3.3
      • OCP V4.3.2

Download PDF

Document Overview What is OceanBase Cloud Platform? Differences between the features of OCP Enterprise Edition and OCP Community Edition System architecture Features System requirements Dependencies Overview Installation process Prepare for the installation Deploy OCP on the GUI Use Docker to deploy OCP Post-deployment check Overview Considerations Preparations Upgrade OCP on the GUI Upgrade OCP using Docker containers Post-upgrade check 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 Overview Create a distributed cluster Create a standalone centralized database 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 Enable automatic detection of deadlocks Disable automatic detection of deadlocks Manage CPU binding configurations Arbitration service Overview Create an arbitration service Take over an arbitration service Stop an arbitration service Start an arbitration service Upgrade an arbitration service Restart an arbitration service Migrate an arbitration service Delete an arbitration service Add an arbitration service Replace an arbitration service Remove an arbitration service Add a zone Edit a zone Restart a zone Stop a zone Delete a zone 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 Upgrade an OceanBase cluster View the topology of a clusterOverview of cluster tenant management View the unit distribution View resource usage Modify the major compaction settings of a cluster Perform a major compaction View details of a major compaction View statistics of a major compaction Manage cluster parameter templates Parameter types View parameters Modify parameters View the history of parameter changes Tenant and resource management View tenant overview information Create a primary tenant Manage unit specificationsView OCP resource unit specifications View the details of a tenant Create a standby tenant Copy a tenant Rename a tenantLock 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 View the topology of a tenant View the topology of primary/standby relationships 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.3
iconOceanBase Cloud Platform
V 4.3.3
  • 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

Create MetaDB

Last Updated:2026-04-20 07:21:01  Updated
share
What is on this page
Prerequisites
Procedure

folded

share

Before you deploy OceanBase Cloud Platform (OCP), you must create the MetaDB component for OCP in OceanBase Admin Toolkit (OAT). If you want to use a deployed MetaDB, you can take it over to OAT. For more information, see Take Over MetaDB.

This topic describes how to create MetaDB in OAT.

Prerequisites

Before you create MetaDB, make sure that:

  • You have installed and logged on to OAT as a super administrator or an O&M engineer. For more information, see Install OAT.
  • You have added the server where MetaDB is to be installed. For more information, see Add a server.
  • Your server meets the resource requirements for installing MetaDB.

Procedure

  1. Log on to OAT.

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

  3. On the Component Management page, click Create a component in the upper-right corner and then select Create MetaDB.

    1

  4. On the Create MetaDB page, specify related parameters.

    1. Specify the basic information of MetaDB.

      Parameter Description
      MetaDB image The Docker image file of MetaDB. Click Manage image files in the drop-down list. In the panel that appears, select Local scan or Remote connection as the mode for adding an image file.
      • The Local scan mode is recommended. You need to upload the image file to the /data/images directory of the OAT container. If the host directory is mounted when OAT is started, you can directly copy the MetaDB image to the directory to which the host is mapped.
      • The Remote connection mode applies when the image repository can be accessed. Enter the address of the Docker repository in Image Repository, such as reg.docker.alibaba-inc.com/xxx/xxx. Enter the image version in Image label, such as 3.3.9-x64. Select an architecture in Architecture as needed.
      Component name The name of the component, which must not be the same as that of any other components. Default value: metadb.
      Server The IP address of the server where MetaDB is to be installed. You can specify multiple server IP addresses. If so, a MetaDB will be installed on each server.
      CPU The number of CPU cores on the server for MetaDB. Default value: 32C.
      Memory The size of memory on the server for MetaDB. Default value: 90GB.
      MetaDB cluster name The name of the MetaDB cluster.
      root@sys password The password of the root user of the sys tenant.

      1

    2. Optional. Configure the installation path of MetaDB.

      Parameter Description
      Installation directory The installation path of MetaDB. Default value: /home/admin/oceanbase. You can change the value.
      Data Directory The data storage path of MetaDB. Default value: /data/1. You can change the value.
      Log Directory The log storage path of MetaDB. Default value: /log/1. You can change the value.
      Backup Directory Optional. The backup path of MetaDB. By default, this parameter is unspecified. You can specify a directory.

      2

    3. Optional. Configure the startup parameters of MetaDB.

      Parameter Description
      MySQL Port The MySQL port of MetaDB. Default value: 2881.
      RPC Port The RPC port of MetaDB. Default value: 2882.
      OB Proxy service port The service port of OBProxy. Default value: 2883.
      SSHD Port The SSHD port in the MetaDB container. Default value: 2022. OCP connects to the SSHD port to deploy OCP Agent.
      root Password The password of the root user in the MetaDB container.

      3

    Note

    • The CPU and memory resources required by MetaDB are the sum of MetaDB resources, MonitorDB resources, resources of the sys tenant, the system memory, and resources of OBProxy. When you allocate resources to MetaDB, we recommend that you reserve a certain margin. This is because the sys tenant itself will also consume resources.
    • When you configure the installation path of MetaDB, make sure that the data directory, installation directory, and log directory are empty, and that the owner of these directories is admin.
    • Make sure that MetaDB images in the same MetaDB cluster use the same hardware architecture. At present, OAT does not support heterogeneous MetaDB images.
    • To deploy a multi-node MetaDB, you can specify multiple server IP addresses in the Server field when you configure basic MetaDB information.****
  5. Click Submit. For any errors in configurations, click Reset to restore the default configurations.

  6. Choose System and Security > Task list. On the task list page that appears, click the task name to view the task details.

Previous topic

Prepare installation media
Last

Next topic

Install OCP
Next
What is on this page
Prerequisites
Procedure