All Products
Search
Document Center

ApsaraDB for OceanBase (Deprecated):Manage the database proxy service

Last Updated:Mar 10, 2026

On the Database Proxy page, you can view basic proxy configuration information, real-time performance monitoring data, and proxy address list. You can also modify proxy configurations.

Prerequisites

  • You have created a cluster instance. For more information, see Purchase an instance.

  • You have created a tenant in the cluster instance. For more information, see Create a tenant.

    Note

    After a tenant is created, ApsaraDB for OceanBase automatically provides proxy services for this tenant.

View basic proxy information

  1. Log in to the   ApsaraDB for OceanBase console.

  2. In the left-side navigation pane, click Instances.

  3. On the Instances page, click the name of the target cluster instance to go to the Cluster Instance Workspace page.

  4. In the left-side navigation pane, click Database Proxy.

  5. In the Performance Monitoring section, you can view the number of transactions processed per second, and the average time consumed in processing an SQL statement of the current cluster instance in the last hour. You can also click More in the upper-right corner to view more performance metrics.

    Monitoring item

    Metric

    Description

    TPS

    transaction_count

    The average number of transactions processed per second.

    Average SQL Statement Processing Time

    qps_rt

    The average time consumed in processing an SQL statement on the server, in milliseconds (ms).

  6. In the proxy address list, you can view the basic information about tenants for which the proxy service is enabled. You can query the proxy address of a specific tenant by tenant name or ID.

    Parameter

    Description

    Proxy Cluster

    The basic information about the proxy cluster. You can view the ID, status, version, zone, specification type, and specification of the proxy cluster. You can also adjust the type and specification of the proxy cluster by referring to Modify configurations.

    Tenant Name/ID

    The tenant name/ID corresponding to the proxy endpoint. You can click the tenant name to go to the tenant details page.

    Proxy Endpoint

    The type and name of the proxy endpoint. Three types of proxy endpoints are supported: primary endpoint, read/write endpoint, and read-only endpoint.

    Endpoint Details

    The private IP address, public IP address, status, maximum number of connections, and direct load port of the proxy endpoint.

    • Click Apply to apply for a public IP address for the primary endpoint. For more information, see Enable public IP addresses.

    • Click the corresponding image button to modify the private IP address, public IP address, or maximum number of connections. For more information, see Modify the maximum number of connections to a proxy address.

    • Click the corresponding image button to copy the private IP address or public IP address.

    • Click Enable to enable a direct load port for the private IP address of the primary endpoint. For more information, see Direct load.

    Read Write Mode

    The read/write mode of the proxy endpoint.

    The read/write mode is readable and writable for a primary endpoint, read/write splitting for a read/write endpoint, and read-only for a read-only endpoint.

    Zone

    The zone where the proxy endpoint is deployed.

    Other Information

    The VPC and characteristic information of the proxy endpoint.

    Actions

    You can click Configure in the Actions column of a proxy endpoint to modify the configuration of that endpoint. For more information about the parameters, see Add an access address.

    Update all cluster architectures

    Allows you to execute a task to upgrade the version of the proxy cluster architecture, for example, from V1.0 to V2.0. For more information, see Upgrade the cluster architecture version.

Modify configurations

  1. Log in to the ApsaraDB for OceanBase console.

  2. In the left-side navigation pane, click Instances.

  3. On the Instances page, click the name of the target cluster instance to go to the Cluster Instance Workspace page.

  4. In the left-side navigation pane, click Database Proxy.

  5. In the Proxy Cluster section, click Change Configuration.

  6. Modify the proxy specification or number of proxy nodes.

Modify the proxy specification

  1. On the Change configuration page, select Agent Specifications.

  2. Modify the parameters.

    Parameter

    Description

    Target Spec Type

    • General: Your database proxy service instance shares CPU resources with other users. The specification of your database proxy service instance is allocated based on the actual size of your cluster. This specification type applies to business with stable and average traffic.

    • Exclusive: Your database proxy service instance uses exclusive CPU resources. You can scale out the resource specification of your database proxy service instance based on business needs. This specification type is billable and applies to business with high access traffic. For more information, see Billing of database proxies.

    Target Spec

    The specification of your database proxy service instance. You can adjust the specification at a step of 2C4G, which means 2 CPU cores and 4 GB of memory.

    image

  3. Click OK.

Modify the number of proxy nodes

Note
  • Only whitelisted users can modify the number of proxy nodes. To use this feature, contact OceanBase Technical Support.

  • You can modify the number of proxy nodes only for the exclusive specification type.

  1. On the Change configuration page, select Number of Proxy Nodes.

  2. Configure the following parameters.

    Parameter

    Description

    Number of Proxy Nodes

    The number of proxy nodes. The default value range is 1 to 15.

    Note

    The default maximum number of proxy nodes is 15 for the exclusive specification type. If you need more nodes, contact OceanBase Technical Support.

    Destination Proxy Address

    The proxy endpoint you want to select.

    image

  3. Click OK.

Upgrade the cluster architecture version

Note

Cluster architecture version upgrade is supported only for whitelisted users. To use this feature, contact OceanBase Technical Support.

The architecture version of a database proxy cluster can be upgraded to V2.0. For more information, see Overview.

  1. Log in to the ApsaraDB for OceanBase console.

  2. In the left-side navigation pane, click Instances.

  3. On the Instances page, click the name of the target cluster instance to go to the Cluster Instance Workspace page.

  4. In the left-side navigation pane, click Database Proxy.

  5. On the Database Proxy page, click Update all cluster architectures in the upper-right corner.

    image

  6. In the dialog box that appears, confirm the upgrade information and click OK.

  7. After the upgrade is completed, the architecture version is V2.0.