OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Migration Service

V3.3.1Community Edition
  • Product updates
  • Product Introduction
    • What is OMS Community Edition?
    • Architecture
      • Overview
      • Hierarchical functional system
      • Basic components
    • Limits
    • Terms
  • Deployment Guide
    • Overview
    • System requirements
    • Resource configuration specifications
    • Prepare the environment
    • Deploy a time-series database (Optional)
    • Deploy OMS Community Edition on a single node
    • Deploy OMS Community Edition on multiple nodes in a single region
    • Deploy OMS Community Edition on multiple nodes in multiple regions
    • Check the deployment
    • Scale out OMS Community Edition
  • User Guide
    • OMS Community Edition console
      • Log on to the OMS Community Edition console
      • Overview
      • User center
        • Configure user information
        • Change your logon password
        • Log off
    • Users and privileges
      • Create a database user
      • User privileges
      • Enable binlogs for the MySQL database
    • Manage data sources
      • Add a data source
        • Add an OceanBase Community Edition data source
        • Add a MySQL data source
        • Add a TiDB data source
        • Add a Kafka data source
        • Add a RocketMQ data source
      • View data source information
      • Copy a data source
      • Edit a data source
      • Delete a data source
    • Data migration
      • Overview
      • Supported DDL operations for incremental migration and limits
      • Create a data migration project
        • Create a project to migrate data from a MySQL database to OceanBase database Community Edition
        • Create a project to migrate data from OceanBase database Community Edition to a MySQL database
        • Migrate data within OceanBase database Community Edition
        • Create an active-active disaster recovery project in OceanBase database Community Edition
        • Create a project to migrate data from a TiDB database to OceanBase database Community Edition
      • Manage data migration projects
        • View details of a data migration project
        • Start, pause, and resume a data migration project
        • Release a data migration project
        • Delete a data migration project
        • Use tags to manage data migration projects
        • Download and import the settings of migration objects
      • Configure matching rules for migration objects
    • Data synchronization
      • Overview
      • Data formats
      • Create a data synchronization project
        • Create a project to synchronize data from an OceanBase database Community Edition to a Kafka instance
        • Create a project to synchronize data from an OceanBase database Community Edition to a RocketMQ instance
      • Manage data synchronization projects
        • View details of a data synchronization project
        • Start, pause, and resume a data synchronization project
        • Release and delete a data synchronization project
        • Use tags to manage data synchronization projects
        • Download and import the settings of synchronization objects
    • OPS & Monitoring
      • Go to the overview page
      • Server
        • View server information
        • Update the quota
        • View server logs
        • Paths of component logs
      • Components
        • Store
          • Create a store
          • View details of a store
          • Update the configurations of a store
          • Start and pause a store
          • Destroy a store
        • Connector
          • View details about a connector
          • Start and pause a connector
          • Migrate a connector
          • Update the configurations of a connector
          • Batch O&M
          • Delete a connector
        • JDBCWriter
          • View details of a JDBCWriter
          • Start and pause a JDBCWriter
          • Migrate a JDBCWriter
          • Update the configurations of a JDBCWriter
          • Batch O&M
          • Delete a JDBCWriter
        • Checker
          • View details of a checker
          • Start and pause a checker
          • Rerun and recover a checker
          • Update the configurations of a checker
          • Delete a checker
      • O&M ticket
        • View details of an O&M ticket
        • Skip a ticket or sub-ticket
        • Retry a ticket or sub-ticket
      • Component parameters
        • Store parameters
          • Parameters of a MySQL store
          • Parameters of an OceanBase store
        • Connector parameters
          • Parameters of a destination RocketMQ instance
          • Parameters of a DataflowSink instance
          • Parameters of a destination Kafka instance
          • Parameters of a source database in full migration
          • Parameters for intermediate-layer synchronization
        • JDBCWriter parameters
        • Checker parameters
    • System management
      • User management
      • Alert center
        • View project alerts
        • View system alerts
        • Manage alert settings
      • Associate with OCP
      • System Parameters
        • Modify system parameters
        • Modify HA configurations
  • Alert Reference
    • oms_host_down
    • oms_host_down_migrate_resource
    • oms_host_threshold
    • oms_migration_failed
    • oms_migration_delay
    • oms_sync_failed
    • oms_sync_status_inconsistent
    • oms_sync_delay
  • API Reference
    • Obtain the status of a migration project
    • Obtain the status of a synchronization project
  • Upgrade Guide
    • Overview
    • Upgrade OMS Community Edition in single-node deployment mode
    • Upgrade OMS Community Edition in multi-node deployment mode
    • FAQ

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Migration Service
  3. V3.3.1

Modify HA configurations

Last Updated:2026-09-04 08:14:02

Overview
Basic principles of store HA
HA parameters and definitions
Modify HA configurations

This topic describes the concepts, parameters, and scenarios of the high availability (HA) feature and the procedure for configuring HA parameters in the OceanBase Migration Service (OMS) Community Edition console.

Overview

HA clusters are an effective solution to ensure business continuity. During 24/7 business operation of enterprise users, the interruption of data synchronization even within minutes causes impact on the business.

With years of application in enterprise scenarios, OMS Community Edition provides a high-availability cluster architecture that allows recovery in seconds. It supports disaster recovery for hosts, IDCs, and even regions, to meet the requirements of latency-sensitive enterprise users.

The Store, Connector, and JDBCWriter components of OMS Community Edition support HA.

Basic principles of store HA

OMS Community Edition manages the HA feature at the subtopic level. HA is enabled for stores under a subtopic based on the exceptions of the subtopic. Therefore, when store HA is enabled, a store exception may not trigger the generation of a new store for disaster recovery. Store HA is enabled based on the following basic principles:

  • When the HA module detects a store exception, if the difference between the latest heartbeat time of the store and the current time does not exceed the value of the checkModuleExceptionIntervalSec parameter, the HA module determines that the store is normal.

  • HA is not enabled for a subtopic if at least one store under the subtopic is normal.

  • When none of the stores under a subtopic is normal, the following rules apply:

    • If a store is scheduled for a primary/standby switchover, the HA module does not trigger the generation of a new store, but waits for the store to restore.

    • If none of the stores under a subtopic is normal and the number of stores under the subtopic does not reach the value of the subtopicStoreNumberThreshold parameter, the HA module triggers a ticket to create new stores. Otherwise, the HA module does not take any action.

    • If some stores are faulty and some stores are stopped under a subtopic, the HA module cannot determine the cause.

      If the number of stores under the subtopic does not reach the value of the subtopicStoreNumberThreshold parameter, the HA module triggers a ticket to create new stores. Otherwise, the HA module does not take any action.

    • If all stores under a subtopic are stopped, the HA module does not take any action.

    • If a store exits not because of an exception, the HA module takes it as a normally stopped store.

  • The HA module creates a store based on the value of the refetchStoreIntervalMin parameter, which indicates the number of minutes before the current time.

HA parameters and definitions

The ha.config file is as follows:

{
"enable":false,
"enableHost":false,
"enableStore":true,"
enableConnector":true,
"enableJdbcWriter":true,
"subtopicStoreNumberThreshold":5,
"checkRequestIntervalSec":600,
"checkJdbcWriterIntervalSec":600,
"checkHostDownIntervalSec":540,
"checkModuleExceptionIntervalSec":240,
"clearAbnormalResourceHours":72,
"refetchStoreIntervalMin":30
}
Parameter
Description
Default value
enable Specifies whether to enable HA. Valid values: true and false. false
enableHost Specifies whether to enable HA for host nodes in the OMS cluster. Valid values: true and false. When hosts are down, the HA module triggers tickets for the batch migration of the connector and JDBCWriter component instances. For more information about OMS downtime migration, see oms_host_down. false
enableStore Specifies whether to enable HA for the store component instances. Valid values: true and false. The HA module supports primary/standby store switchover and can recycle stores with exceptions:
  • Primary/standby store switchover If a store under a subtopic is scheduled for a primary/standby switchover, the HA module creates a ticket to restore the store.
  • Recycling of stores with exceptions When an exception occurs to a store under a subtopic, the HA module checks whether the difference between the latest heartbeat time of the store and the current time exceeds the value of the clearAbnormalResourceHours parameter. If yes, the ticket for the store is deleted.
true
enableConnector Specifies whether to enable the Connector daemon. Valid values: true and false. enableConnector is applicable to scenarios with abnormal Connectors. true
enableJdbcWriter Specifies whether to enable the JDBCWriter daemon. Valid values: true and false. enableJDBCWriter is applicable to scenarios with abnormal JDBCWriters. true
subtopicStoreNumberThreshold The maximum number of stores under a subtopic. The value of this parameter is verified before the HA module performs an operation. 5
checkRequestIntervalSec The interval, in seconds, for triggering HA tickets for the same operation object, for example, the IP, Store, Connector, or JDBCWriter component. 600
checkJdbcWriterIntervalSec The duration, in seconds, before HA is enabled for a faulty JDBCWriter component. HA is enabled for a faulty JDBCWriter component only when the JDBCWriter component has become inactive for the specified duration. 600
checkHostDownIntervalSec Specifies the time elapsed during which the host does not report a heartbeat, when a host is considered down in downtime migration scenarios. 540
checkModuleExceptionIntervalSec The time threshold, in seconds, for which a faulty store can stay active before HA is enabled. This parameter is available if store HA is enabled. 240
clearAbnormalResourceHours The time interval, in hours, for clearing redundant faulty stores when store HA is enabled, based on the GmtModfied parameter of the store component. 72
refetchStoreIntervalMin The time interval, in minutes, for pulling stores. 30

Modify HA configurations

You can modify the parameters of the ha.config file in the OMS Community Edition console.

  1. Log on to the OMS Community Edition console.

  2. In the left-side navigation pane, choose System Management > System Parameters.

  3. On the System Parameters page, find ha.config.

  4. Click the edit icon next to Value of the parameter name.

  5. In the Modify Value dialog box, change the value as needed.

  6. Click OK.

Previous topic

Modify system parameters
Last

Next topic

oms_host_down
Next
on this page
Overview
Basic principles of store HA
HA parameters and definitions
Modify HA configurations