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

Databases

OceanBase DatabaseOceanBase AI 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 ServiceOceanBase DataPilotOceanBase OAgent

Connectors and Middleware

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

Databases

OceanBase DatabaseOceanBase AI 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 ServiceOceanBase DataPilotOceanBase OAgent
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase OAgent

V2.2.0
  • Product overview
    • What is OAgent?
    • Key features
    • System architecture
    • Use cases
  • Quick start
  • Deployment
  • Overview
  • Sessions and diagnosis
    • Manage sessions
    • Switch dialogue models
    • Use @ to mention the analysis target
    • View the tool invocation process
    • Upload an attachment
    • Data visualization
    • FAQ
    • Export a report
  • Tools
  • Skill Management
  • Channel management
  • Knowledge base
    • Built-in knowledge base
    • Custom knowledge base
  • Scheduled tasks
    • Overview of scheduled tasks
    • Create a scheduled task
  • View usage
  • Model configuration
    • Manage model services
    • Model scoring
  • Settings and security
    • Product management
    • Experimental features
  • Best practices
    • Perform a cluster health inspection
    • Query cluster and topology information
    • Query resource metrics and task status
    • Read-only queries
    • Alert query and troubleshooting guide
    • Root cause analysis of exceptions
    • ASH diagnostic report
    • Analyze slow SQL, TopSQL, and abnormal SQL
    • SQL pre-analysis and tuning recommendations
    • Interpret execution plans
    • Diagnostic information statistics
    • Parameter check and change governance
    • Database change ticket
  • Appendix
    • Feature list
    • Built-in Skills
  • Release notes
    • OAgent V2.2.0 Release note
    • OAgent V2.1.0 Release note
    • OAgent V2.0.0 Release note
    • OAgent V1.8.0 Release note

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase OAgent
  3. V2.2.0

Product management

Last Updated:2026-11-20 07:25:11

Prerequisites
Procedure
Editing and modifying
What to do next

This topic describes how to create a product connection in OAgent to access OCP and OAS services.

Prerequisites

  • You have obtained the service address, login account, and password of OCP, and the account has the permission to view the target cluster and tenant.

  • If you need to use diagnostic capabilities such as slow SQL, ASH, or root cause analysis, you have obtained the service address of OAS and the username and password for HTTP Basic authentication.

  • The network is connected between OAgent Gateway and the service addresses of OCP/OAS.

Procedure

  1. In the left navigation bar, click More to go to the Product Management page.

  2. Click Create Product in the upper-right corner.

  3. In the Create Product dialog box, configure the following parameters.

    Parameter
    Description
    Product Name The display name of the product, used to reference it with @ or by name in sessions. It is recommended to use a name that identifies its environment purpose, for example, "Production OB".
    OCP Address The service access address of OCP, in the format https://<OCP domain name or IP>:<port>.
    OCP Username The account for logging into OCP, for example, admin.
    OCP Password The password corresponding to the above OCP account.
    OAS Address (Optional) The service access address of OAS, in the format https://<OAS domain name or IP>.
    OAS Username (Optional) The HTTP Basic authentication username for OAS, which must match the configuration on the gateway side.
    OAS Password (Optional) The HTTP Basic authentication password for OAS.
  4. Click OK.

    After successful saving, the product appears in the product list, and OAgent automatically pulls the cluster and tenant information under it.

Editing and modifying

After a product is created, you can adjust it at any time on the Product Management page:

  • Edit: Click Edit on the product card to modify parameters such as the product name, OCP/OAS addresses, and credentials. After modification, click OK to save. The new configuration takes effect immediately, ongoing sessions are not affected, and subsequent tool calls will use the updated credentials.

  • Delete: Click Delete on the product card. After confirmation, the product and all connection information under it will be removed. After deletion, historical sessions that depend on this product will no longer be able to initiate new tool calls.

What to do next

  • To start analysis for a cluster under this product in a session, select the cluster with @. For details, see Use @ to mention the analysis object.

  • To verify if a connection is available, ask a question like " has which clusters?" in a session.

Notice

After you change the password of an OCP or OAS account, you must update the credentials saved in Product Management. Otherwise, all tool calls under this product will return authentication failures.

Previous topic

Model scoring
Last

Next topic

Experimental features
Next
on this page
Prerequisites
Procedure
Editing and modifying
What to do next