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 Admin Tool

V4.4.1
  • What's New
  • Product Introduction
    • What is OAT?
    • Architecture
    • Glossary
  • Quick Start
    • Install OAT
    • Get started with OAT
  • oatcli
  • Upgrade guide
  • User Guide
    • Log in to OAT
    • Page layout of the OAT console
    • Servers
      • Add a server
      • Edit a server
      • Maintain a server
      • Remove a server
      • Manage credentials
    • Product services
      • Product service versions that support IPv6
      • Install, upgrade, roll back, and uninstall OCP
      • Install, upgrade, roll back, and uninstall ODC
      • Install, upgrade, and uninstall OMS
      • Install, upgrade, roll back, and uninstall OAS
      • Install, upgrade, roll back, modify, and uninstall OB Sharding
      • Install, upgrade, and uninstall MetaDB
      • Install and uninstall OBDNS
      • Install and uninstall InfluxDB
      • Install and uninstall NLB
      • Install and uninstall OpenSearch
      • Install and uninstall SQLAuditStore
      • Create, upgrade, and uninstall an arbitration service
      • Install and uninstall OBLB
      • Take over OCP
      • Take over ODC
      • Take over OB Sharding
      • Take over OMS
      • Take over MetaDB
      • Take over OBDNS
      • Take over InfluxDB
      • Take over NLB
      • Take over the Arbitration Service
      • Manage images
      • Change resources of services and components
      • Manage tools
      • Refresh data
      • Manage containers
    • Operation and maintenance
      • In-depth inspection
        • Overview
        • Configure inspection items
        • Initiate an in-depth inspection
          • Initiate an in-depth inspection for a single object
          • Initiate a global in-depth inspection
          • Initiate an in-depth inspection for multiple objects
        • View an inspection task
        • Manage an inspection report
          • View an inspection report
          • Download an inspection report
      • High availability testing
        • Create a high availability test
        • View the high availability test
    • System security
      • Use the task center
      • Manage packages
      • Manage users
      • Audit operations
      • System parameters
        • View and modify system parameters
        • OAT configuration parameters
  • FAQ
  • Release Notes
    • OAT V4.4.1
    • OAT V4.4.0
    • OAT V4.3.2
    • OAT V4.3.1
    • OAT V4.3.0

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Admin Tool
  3. V4.4.1

Take over OB Sharding

Last Updated:2026-09-03 09:50:27

Prerequisites
Procedure
What to do next

This topic describes how to take over OB Sharding in the OceanBase Admin Toolkit (OAT) console. OAT of earlier versions cannot be smoothly upgraded to the new version because the new version has been restructured. Therefore, you must use OAT of the new version to take over the services and components deployed by using OAT of earlier versions. This way, you can monitor the status of the services and components and manage their upgrades.

Prerequisites

Before you take over OB Sharding, make sure that the following conditions are met:

  • You have added the image of OB Sharding.
  • You have taken over the components on which OB Sharding relies.
  • You have added a server to take over OB Sharding. For more information, see Add a server.
  • The server meets the requirements for taking over OB Sharding.

Procedure

To take over OB Sharding, perform the following steps:

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

  2. On the Products page, click Take Over Products in the upper-right corner and choose Take Over OBSharding.

  3. On the Take Over OBSharding page, configure the parameters.

    The following table describes the basic parameters of OB Sharding.

    Parameter
    Description
    OBSharding Console Image The Docker image of the OB Sharding console.
    Product Name The name of the service, which must be unique.
    Server The IP address of the server to take over OB Sharding.
    CPU The number of CPU cores available to the OB Sharding server. Default value: 8.
    Memory The size of memory available to the OB Sharding server, in GB. Default value: 20.

    The following table describes the parameters of the OB Sharding server.

    Parameter
    Description
    OBSharding Server Image The Docker image of the OB Sharding server.
    Server The IP address of the server on which you want to install the OB Sharding server.
    Service Port The port number of the OB Sharding server.
    CPU The number of CPU cores available to the OB Sharding server. Default value: 8.
    Memory The size of memory available to the OB Sharding server, in GB. Default value: 16.

    The following table describes the MetaDB parameters of OB Sharding.

    Parameter
    Description
    MetaDB Type The type of MetaDB.
    Select Created MetaDB The existing MetaDB component to be used for OB Sharding.

    The following table describes the load balancing parameters. The parameters are optional.

    Parameter
    Description
    Load Balancing Mode The load balancing mode.
    MetaDB TCP Proxy IP The proxy IP address or domain name used by the OB Sharding console to connect to MetaDB.
    MetaDB TCP Proxy Port The proxy port used by the OB Sharding console to connect to MetaDB. Default value: 3306.
    OBSharding Console HTTP Proxy IP The IP address for accessing the OB Sharding console.
    OBSharding Console HTTP Proxy Port The port for accessing the OB Sharding console. Default value: 80.
  4. After the parameters are configured, click Submit. You can also click Reset to restore to the default configurations.

What to do next

After you take over OB Sharding, you can upgrade OB Sharding based on your business requirements. For more information, see Upgrade OB Sharding.

Previous topic

Take over ODC
Last

Next topic

Take over OMS
Next
on this page
Prerequisites
Procedure
What to do next