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

Associate with OCP

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

Background information
Limits
Add an OCP cluster
Modify an associated OCP
Delete an associated OCP cluster

You can associate OceanBase Migration Service (OMS) Community Edition with OceanBase Cloud Platform (OCP) clusters. This topic describes how to add, modify, and delete an OCP cluster in the OMS Community Edition console.

Background information

OCP is the management platform of OceanBase Database. You can create OceanBase clusters and perform cluster O&M and monitoring operations in the OCP console. When OMS Community Edition needs to obtain the clogs of an OceanBase data source or use OCP as the alert channel, you must associate OMS Community Edition with an OCP cluster. OMS Community Edition uses the Java Database Connectivity (JDBC) connection URL to connect to the OCP MetaDB and query the information required for data migration.

Limits

OMS Community Edition supports only OCP V3.1.1-CE and V3.3.0-CE.

Add an OCP cluster

  1. Log on to the OMS Community Edition console.

  2. In the left-side navigation pane, choose System Management > Associated OCP Cluster.

  3. On the Associated OCP Cluster page, click Add Associated OCP Cluster.

  4. In the Add Associated OCP Cluster dialog box, specify the following parameters.

    Parameter
    Description
    OCP Cluster Name The name of the OCP cluster. The name must be 3 to 32 characters in length.
    Endpoint The URL used by OMS Community Edition to access the OCP cluster. The value is in the IP address:port number format.
    API Username The logon username used by OMS Community Edition to access the OCP cluster.
    API Password The logon password used by OMS Community Edition to access the OCP cluster.
    Version Optional. The version of OCP.
  5. Click Test Connection.

  6. After the test succeeds, click Submit.

    You can also click Cancel and return to the OCP List page.

Modify an associated OCP

  1. On the Associated OCP Cluster page, click Modify in the Actions column of the OCP cluster that you want to modify.

  2. In the Modify Associated OCP dialog box, modify parameters as needed.

    Notice

    You cannot modify the OCP Cluster Name and Endpoint parameters.

  3. Click Test Connection.

  4. After the test succeeds, click Submit.

    You can also click Cancel and return to the OCP List page.

Delete an associated OCP cluster

To delete an associated OCP cluster, you must release the running data migration or synchronization project that involves the associated data source.

  1. On the Associated OCP Cluster page, click Delete in the Actions column of the OCP cluster that you want to delete.

  2. In the dialog box that appears, click OK.

Previous topic

Manage alert settings
Last

Next topic

Modify system parameters
Next
on this page
Background information
Limits
Add an OCP cluster
Modify an associated OCP
Delete an associated OCP cluster