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

V4.5.0

  • 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 servers
      • 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.5.0
    • OAT V4.4.1
    • OAT V4.4.0
    • OAT V4.3.2
    • OAT V4.3.1
    • OAT V4.3.0

Download PDF

What's New What is OAT? Architecture Glossary Install OAT Get started with OAT oatcli Upgrade Guide Log in to OAT Page layout of the OAT console Add a server Edit a server Maintain a server Remove servers Manage credentials 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 Use the task center Manage packages Manage users Audit operations FAQ OAT V4.5.0 OAT V4.4.1 OAT V4.4.0 OAT V4.3.2 OAT V4.3.1 OAT V4.3.0
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 Admin Tool
  3. V4.5.0
iconOceanBase Admin Tool
V 4.5.0
  • V 4.5.0
  • V 4.4.1
  • V 4.4.0
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.1
  • V 4.1.2

Install, upgrade, roll back, and uninstall OAS

Last Updated:2026-04-09 08:27:14  Updated
share
What is on this page
Prerequisites
Install OAS
Upgrade OAS
Roll back the OAS version
Uninstall OAS

folded

share

This topic describes how to install, upgrade, roll back, and uninstall OAS by using OAT.

Prerequisites

Before you install OAS, make sure that the following conditions are met:

  • You have installed OAT and logged in as a super administrator or an O&M engineer. For more information, see Install OAT..
  • You have added a server to install OAS. For more information, see Add a server. .
  • You have created the MetaDB component for OAS. For more information, see Create MetaDB.

Install OAS

To install OAS, perform the following steps:

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

  2. On the Product Management page, click Install the product in the upper-right corner and choose Install OAS.

  3. On the Install OAS page, configure the parameters.

    The following table describes the basic parameters of OAS.

    Parameter Explanation
    OAS Image The OAS image. You can select the latest version or click Manage image files in the drop-down list to add a new image.
    Product Name The name of the product. The name must be unique.
    Associated OCP The OCP to be associated with OAS.

    Note

    • If you cannot access OCP, you can enter the admin password of OCP.
    • The version of the selected OCP must be V4.3.5 or later.

    Server The IP address of the server on which you want to install OAS. You can select one or more IP addresses.
    CPU The number of CPU cores available to OAS on each server.
    Memory The size of memory available to OAS on each server.
    HTTP Port The HTTP port for OAS to provide services. The default value is 8990.
    AI Console Port The port for the OAS AI assistant console. The default value is 8991.
    AI Server Port The port for the core service of the OAS AI assistant. The default value is 8992.
    Log Directory The log storage path of OAS. The default value is /home/admin/logs/oas.

    The following table describes the MetaDB parameters of OAS.

    Parameter Explanation
    MetaDB Type The type of MetaDB. Valid values:
    • Created MetaDB
    • Other OB_MySQL
    Select Created MetaDB The MetaDB to be associated with OAS.
    Tenant Name The name of the tenant. The default value is oas_meta.
    Tenant Password The password of the tenant.
    Database Name The name of the database. The default value is oas_metadb.
    Tenant CPU The number of CPU cores available to MetaDB on each server. The default value is 2C.
    Memory The size of memory available to MetaDB on each server. The default value is 5G.

    Load balancing:

    You can choose one of the following load balancing modes:

    • Created NLB: NLB automatically adds load balancing rules for the HTTP service address of the product based on the VIP and VPORT that you specify. If you select MetaDB has been created., NLB also automatically adds load balancing rules for MetaDB.

    • Created OBDNS: OBDNS automatically adds load balancing rules for the HTTP service address of the product based on the Domain Name and VPORT that you specify. If you select MetaDB has been created., OBDNS also automatically adds domain name resolution for the servers of MetaDB.

    • Other Load Balancing:

      Parameter Explanation
      MetaDB TCP Proxy IP The proxy IP address or domain name for OAS to connect to MetaDB.
      MetaDB TCP Proxy Port The proxy port for OAS to connect to MetaDB. The default value is 3306.
      HTTP Proxy IP The IP address for OAS to provide services.
      HTTP Proxy Port (VPORT) The HTTP proxy port for OAS. The default value is 80.
    • Do Not Use: If you select this option, high availability is not supported. The IP address of the first server is used as the connection information by default.

  4. After you configure the parameters, click Submit.

    If you want to restore the default configurations, click Reset.

Upgrade OAS

Notice

When you upgrade OCP V4.3.5 to a later version, the OAS service is unavailable:

  • After you upgrade the OCP system, immediately upgrade OAS.
  • OAS is unavailable during the OCP/OAS upgrade. We recommend that you plan a maintenance window in advance.

To upgrade OAS, perform the following steps:

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

  2. Find the OAS service that you want to upgrade and click the name in the Name column to go to the details page.

    Note

    You can also search for the service by name at the top of the page.

  3. In the upper-right corner of the details page, click Upgrade.

  4. In the Upgrade dialog box, specify the required information.

    The following table describes the related parameters.

    Parameter Description
    Upgrade Mode Select Stop Service. This option is applicable to services that do not require business continuity. During the upgrade, OAT stops the service of the previous version and cannot provide services.
    Select the image file for the upgrade The image file to be upgraded.
  5. Click Confirm.

Roll back the OAS version

If the OAS upgrade task is successful, perform the following steps to roll back the OAS version:

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

  2. Find the OAS service that you want to roll back and click the name in the Name column to go to the details page.

    Note

    You can also search for the service by name at the top of the page.

  3. In the upper-right corner of the details page, click Version rollback.

  4. In the Version rollback dialog box, specify the required information.

    The following table describes the related parameters.

    Parameter Description
    Select the metadata backup file The metadata file to be used for the version rollback.
    Select the image file for the version rollback The image file to be used for the version rollback.
    The rollback will lose all monitoring and diagnostic data You can select this option.
    The rollback will lose all data records generated during the current version and the new features/services added in the current version may be unavailable. You can select this option.
  5. Click Sure..

Uninstall OAS

To uninstall OAS, perform the following steps:

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

  2. Find the OAS service that you want to uninstall and click the name in the Name column to go to the details page.

    Note

    You can also search for the service by name at the top of the page.

  3. In the upper-right corner of the details page, click Uninstall.

  4. In the dialog box that appears, click Sure..

Previous topic

Install, upgrade, and uninstall OMS
Last

Next topic

Install, upgrade, roll back, modify, and uninstall OB Sharding
Next
What is on this page
Prerequisites
Install OAS
Upgrade OAS
Roll back the OAS version
Uninstall OAS