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 Cloud

  • Product Updates & Announcements
    • What's new
      • Release notes for 2026
      • Release notes for 2025
      • Release notes for 2024
      • Release history
    • Product announcements
      • Notice of underlying component upgrades for OceanBase Cloud database proxy clusters on Alibaba Cloud
      • AI Service Model Launch and Delisting Notice
      • Data development module deprecation notice
      • Optimization of Backup and Restore commercialization strategy
      • Database proxy billing update
      • AWS instance pricing adjustment
      • Billing notice for limited-time free OMS instances
      • Notice of cross-AZ data transfer billing adjustments (OceanBase Cloud on AWS)
  • Product Introduction
    • Overview
    • Management mode and scenarios
    • Core features
      • High availability with cross-cloud active-active architecture
      • High availability with cross-cloud primary-standby databases
      • Multi-layer online scaling and on-demand adjustment
    • Deployment modes
    • Product specifications
    • Product billing
      • Overview
      • Instance billing
        • Alibaba Cloud instance billing
        • Huawei Cloud instance billing
        • AWS instance billing
        • Google Cloud instance billing
        • Azure instance billing
      • Backup and restore billing
      • SQL audit billing
      • Migrations billing
      • Database proxy billing
      • Binlog service billing
      • Read-only replica billing
      • AI model billing
    • Supported database versions
  • Get Started
    • Quick start with Flagship Edition
    • Create a Flagship Edition cluster instance
    • Create a tenant
    • Use the database
  • Work with DBaaS Instances
    • Work with flagship edition instances
      • Overview
      • Create an instance
        • Overview
        • Create via OceanBase Cloud official website
        • Create via AWS Marketplace
        • Create via GCP Marketplace
        • Create via Huawei Cloud Marketplace
        • Create via Alibaba Cloud Marketplace
        • Create via Azure Marketplace
      • Connect to an instance
        • Configure network connection
          • Overview
          • Connect using a public IP address
          • Connect using Azure Private Link
          • Connect using Google Cloud Private Service Connect
          • Connect using Huawei Cloud VPC Endpoint
          • Connect using a Huawei Cloud peering connection
          • Connect using AWS PrivateLink
          • Connect using AWS VPC peering
          • Connect using Alibaba Cloud VPC
        • MySQL compatible mode
          • Connect with clients
            • Connect to OceanBase Cloud by using Client ODC
            • Connect to OceanBase Cloud by using a MySQL client
            • Connect to OceanBase Cloud by using OBClient
          • Connect with drivers
            • Java
              • Connect to OceanBase Cloud using SpringBoot
              • SpringBatch sample application for connecting to OceanBase Cloud
              • spring-jdbc
              • SpringDataJPA sample application for connecting to OceanBase Cloud
              • Hibernate application development with OceanBase Cloud
              • Sample program for connecting to OceanBase Cloud
              • connector-j
              • Use TestContainers to connect to and use OceanBase Cloud
            • Python
              • Connect to OceanBase Cloud using mysqlclient
              • Connect to OceanBase Cloud using PyMySQL
              • Use the MySQL-connector-python driver to connect to and use OceanBase Cloud
              • Use SQLAlchemy to connect to an OceanBase Cloud database
              • Connect to an OceanBase Cloud database using Django
              • Connect to an OceanBase Cloud database by using peewee
            • C
              • Use MySQL Connector/C to connect to OceanBase Cloud
            • Go
              • Connect to OceanBase Cloud using the Go-SQL-Driver/MySQL driver
              • Connect to OceanBase Cloud using GORM
            • PHP
              • Use the EXT driver to connect to OceanBase Cloud
              • Connect to OceanBase Cloud by using the MySQLi driver
              • Use the PDO driver to connect to OceanBase Cloud
            • Rust
              • Rust application example for connecting to OceanBase Cloud
              • SeaORM example for connecting to OceanBase Cloud
            • Ruby
              • ActiveRecord sample application for OceanBase Cloud
              • Connect to OceanBase Cloud by using mysql2
              • Connect to OceanBase Cloud by using Sequel
          • Use database connection pool
            • Database connection pool configuration
            • Connect to OceanBase Cloud by using a Tomcat connection pool
            • Connect to OceanBase Cloud by using a C3P0 connection pool
            • Connect to OceanBase Cloud by using a Proxool connection pool
            • Connect to OceanBase Cloud by using a HikariCP connection pool
            • Connect to OceanBase Cloud by using a DBCP connection pool
            • Connect to OceanBase Cloud by using Commons Pool
            • Connect to OceanBase Cloud by using a Druid connection pool
        • Oracle compatible mode
          • Connect with clients
            • Connect to OceanBase Cloud by using OBClient
            • Connect to OceanBase Cloud by using Client ODC
          • Connect with drivers
            • Java
              • Connect to OceanBase Cloud using OceanBase Connector/J
              • Connect to OceanBase Cloud by using Spring Boot
              • SpringBatch application example for connecting to OceanBase Cloud
              • Connect to OceanBase Cloud using Spring JDBC
              • Connect to OceanBase Cloud by using Spring Data JPA
              • Connect to OceanBase Cloud by using Hibernate
              • Use MyBatis to connect to OceanBase Cloud
              • Use JFinal to connect to OceanBase Cloud
            • Python
              • Python Driver for Oracle Mode
            • C/C++
              • Connect to OceanBase Cloud using OceanBase Connector/C
              • Connect to OceanBase Cloud using OceanBase Connector/ODBC
              • Use SqlSugar to connect to OceanBase Cloud
          • Use database connection pool
            • Database connection pool configuration
            • Sample program that uses a Tomcat connection pool to connect to OceanBase Cloud
            • C3P0 connection pool connects to OceanBase Cloud
            • Connect to OceanBase Cloud using Proxool connection pool
            • Sample program that uses HikariCP to connect to OceanBase Cloud
            • Use DBCP connection pool to connect to OceanBase Cloud
            • Connect to OceanBase Cloud by using Commons Pool
            • Connect to OceanBase Cloud by using a Druid connection pool
        • KV compatible mode
          • Connect to a cluster by using the OBKV-HBase client
      • Developer guide
        • MySQL compatible mode
          • Plan database objects
            • Create a database
            • Create a table group
            • Create a table
            • Create an index
            • Create an external table
          • Write data
            • Insert data
            • Update data
            • Delete data
            • Replace data
            • Generate test data in batches
          • Read data
            • Single-table queries
            • Join tables
              • INNER JOIN queries
              • FULL JOIN queries
              • LEFT JOIN queries
              • RIGHT JOIN queries
              • Subqueries
              • Lateral derived tables
            • Use operators and functions in queries
              • Use arithmetic operators in queries
              • Use numerical functions in queries
              • Use string concatenation operators in queries
              • Use string functions in queries
              • Use datetime functions in queries
              • Use aggregate functions in queries
              • Use NULL-related functions in queries
              • Use the CASE conditional operator in queries
              • Use the SELECT ... FOR UPDATE statement to lock query results
              • Use the SELECT ... LOCK IN SHARE MODE statement to lock query results
            • Use a DBLink in queries
            • Set operations
          • Manage transactions
            • Overview
            • Start a transaction
            • Savepoints
              • Mark a savepoint
              • Roll back a transaction to a savepoint
              • Release a savepoint
            • Commit a transaction
            • Roll back a transaction
        • Oracle compatible mode
          • Plan database objects
            • Create a table group
            • Create a table
            • Create an index
            • Create an external table
          • Write data
            • Insert data
            • Update data
            • Delete data
            • Replace data
            • Generate test data in batches
          • Read data
            • Single-table queries
            • Join tables
              • INNER JOIN queries
              • FULL JOIN queries
              • LEFT JOIN queries
              • RIGHT JOIN queries
              • Subqueries
              • Lateral derived tables
            • Use operators and functions in queries
              • Use arithmetic operators in queries
              • Use numerical functions in queries
              • Use string concatenation operators in queries
              • Use string functions in queries
              • Use datetime functions in queries
              • Use aggregate functions in queries
              • Use CASE functions in queries
            • Use a DBLink in queries
            • Set operations
          • Manage transactions
            • Overview
            • Start a transaction
            • Savepoints
              • Mark a savepoint
              • Roll back a transaction to a savepoint
            • Commit a transaction
            • Roll back a transaction
        • KV compatible mode
          • OBKV-Table Java development guide
          • Table data operation examples
            • Insert data with OBKV-Table
            • Query data with OBKV-Table
            • Update data with OBKV-Table
            • Delete data with OBKV-Table
          • Table Java development
            • Connect to an instance by using the OBKV-Table Java client
          • HBase data operation examples
            • OBKV-HBase application development overview
            • OBKV-HBase data operation examples
      • Manage instances
        • Manage instances
          • View the instance list
          • Instance workbench overview
          • Stop and start instances
          • Unit migration
        • Manage tenants
          • Tenant overview
          • Create a tenant
          • Modify tenant specifications
          • Modify tenant names
          • Add an endpoint
          • Resource isolation
            • Overview
            • Manage resource groups
              • Create a resource group
              • View a resource group
              • Edit a resource group
              • Delete a resource group
            • Manage isolation rules
              • Create an isolation rule
              • View isolation rules
              • Edit an isolation rule
              • Delete a quarantine rule
          • Modify primary zone
          • Modify the maximum number of connections for a tenant proxy
          • Enable the AI function built-in AI models
          • Monitor tenant performance
            • Overview
            • View performance and SQL monitoring details
            • View transaction monitoring details
            • View storage and cache monitoring details
            • View Binlog service monitoring
            • Customize a monitoring dashboard for a tenant
          • Diagnostics
            • View performance monitoring data
            • Real-time diagnostics
              • SQL diagnostics
                • Top SQL
                • Slow SQL
                • Suspicious SQL
                • High-risk SQL
                • SQL details
              • Session management
                • Session management
              • Optimization management
                • Manage active outlines
                • View optimization history
              • SQL audit
          • Manage tenant parameters
            • Manage tenant parameters
            • Parameters for tenants
            • Parameter template overview
          • Delete a tenant
          • Manage databases and accounts
            • Create accounts
            • Manage accounts
            • Create a database (MySQL compatible mode)
            • Manage databases (MySQL compatible mode)
        • Monitor instance performance
          • Overview
          • Monitor the performance of databases in an instance
          • Monitor multidimensional metrics of an instance
          • Monitor the performance of hosts in an instance
          • Monitor database proxy
          • Monitor database proxy hosts
          • Monitor cross-cloud network performance
          • Customize a monitoring dashboard for an instance
        • Manage major compactions
          • Initiate a major compaction
          • View compaction records
          • Update time for compactions
        • Manage instance parameters
          • Manage parameters
          • Parameters for cluster instances
        • Change instance configurations
          • Set compute auto-scaling
          • Set storage auto-scaling
          • View history of configuration changes
          • Change configuration
          • Switch the deployment mode
        • Manage standby instances
          • Overview
          • Create a standby instance
          • Create a cross-cloud standby instance
          • Primary-standby instance workspace
          • Configure a primary-standby synchronization strategy
          • Configure global endpoint
          • Enable automatic forwarding of standby write requests
          • Primary-standby instance switchover
          • Initiate failover
          • Detach a standby instance
          • Release a standby instance
        • Release an instance
        • Database proxy
          • Overview
          • Manage database proxy
          • Direct load
        • Manage alerts
          • Overview
          • Manage alert rules
            • Create an alert rule
            • View an alert rule
            • Edit an alert rule
            • Delete an alert rule
          • View alert history
          • Manage alert templates
            • Create an alert template
            • View an alert template
            • Edit an alert template
            • Copy an alert rule template
            • Delete an alert template
          • Manage muting rules
            • Create an alert muting rule
            • View an alert muting rule
            • Edit an alert muting rule
            • Delete an alert muting rule
          • Manage alert notification templates
            • Create an alert notification template
            • View an alert notification template
            • Edit an alert notification template
            • Copy an alert notification template
            • Delete an alert notification template
          • Manage alert contacts
            • Add an alert contact
            • Add an alert contact group
            • View an alert contact
            • Edit an alert contact
            • Delete an alert contact
            • Obtain a webhook URL
          • Monitoring metrics for alerts
        • Backup and restore
          • Overview
          • Backup strategy
          • Initiate a backup immediately
          • Data backup
          • Initiate a restore
          • Data restore
          • Restore data from the instance recycle bin
        • Diagnostics
          • View performance monitoring data
          • Capacity diagnostics
          • One-click diagnostics
            • Initiate one-click diagnostics
            • View one-click diagnostic report
              • Exceptions
              • Real-time diagnostics
              • Optimization suggestions
              • Capacity management
              • Security management
          • Real-time diagnostics
            • SQL diagnostics
              • Top SQL
              • Slow SQL
              • Suspicious SQL
              • High-risk SQL
              • SQL details
              • SQL monitoring metrics list
            • Session management
              • Session management
            • Request analysis
              • Request analysis
          • Root cause diagnostics
            • Exception handling
            • Enable system autonomy
          • SQL audit
          • Materialized view analysis
          • Optimization center
            • Optimization suggestions
            • Manage active outlines
            • SQL review
            • View the optimization history
        • Manage read-only replicas
          • Overview
          • Instance read-only replicas
            • Add a read-only replica to an instance
            • View read-only replicas of an instance
            • Manage read-only replicas of an instance
            • Delete a read-only replica of an instance
          • Tenant read-only replicas
            • Add a read-only replica to a tenant
            • View read-only replicas of a tenant
            • Manage read-only replicas of a tenant
            • Delete a read-only replica of a tenant
        • Manage tags
        • Manage JVM-dependent services
      • Data source management
        • Overview of data source management
        • Manage data sources
        • User privileges
          • User privileges for compatibility assessment
          • User privileges for data migration
          • User privileges for performance assessment
          • User privileges for data archiving
          • User privileges for data cleanup
        • Connect via private network
          • AWS
          • Huawei Cloud
          • Alibaba Cloud
          • Azure
          • Private IP address segments
        • Connect via public network
          • AWS
          • Huawei Cloud
          • Alibaba Cloud
          • Azure
      • Data lifecycle management
        • Archive data
        • Clean up data
      • Manage recycle bin
        • Instance recycle bin
        • Manage databases and tables in recycle bin
          • Overview
          • Instance-level recycle bin
          • Tenant-level recycle bin
    • Work with transactional instances
      • Overview
      • Create an instance
        • Overview
        • Create via OceanBase Cloud official website
        • Create via AWS Marketplace
        • Create via GCP Marketplace
        • Create via Huawei Cloud Marketplace
        • Create via Alibaba Cloud Marketplace
        • Create via Azure Marketplace
      • Connect to an instance
        • MySQL compatible mode
          • Overview
          • Get connection string
            • Overview
            • Connect to a database by using AWS PrivateLink
            • Access the database by using an Azure private network connection
            • Connect using AWS VPC peering
            • Connect using Google Cloud Private Service Connect
            • Connect using Huawei Cloud VPC Endpoint
            • Connect using Alibaba Cloud VPC
            • Connect using a public IP address
            • Connect using a Huawei Cloud peering connection
          • Connect with clients
            • Connect to OceanBase Cloud by using Client ODC
            • Connect to OceanBase Cloud by using a MySQL client
            • Connect to OceanBase Cloud by using OBClient
          • Connect with drivers
            • Java
              • Connect to OceanBase Cloud using SpringBoot
              • SpringBatch sample application for connecting to OceanBase Cloud
              • spring-jdbc
              • SpringDataJPA sample application for connecting to OceanBase Cloud
              • Hibernate application development with OceanBase Cloud
              • Sample program for connecting to OceanBase Cloud
              • connector-j
              • Use TestContainers to connect to and use OceanBase Cloud
            • Python
              • Connect to OceanBase Cloud using mysqlclient
              • Connect to OceanBase Cloud using PyMySQL
              • Use the MySQL-connector-python driver to connect to and use OceanBase Cloud
              • Use SQLAlchemy to connect to an OceanBase Cloud database
              • Connect to an OceanBase Cloud database using Django
              • Connect to an OceanBase Cloud database by using peewee
            • C
              • Use MySQL Connector/C to connect to OceanBase Cloud
            • Go
              • Connect to OceanBase Cloud using the Go-SQL-Driver/MySQL driver
              • Connect to OceanBase Cloud using GORM
            • PHP
              • Use the EXT driver to connect to OceanBase Cloud
              • Connect to OceanBase Cloud by using the MySQLi driver
              • Use the PDO driver to connect to OceanBase Cloud
            • Rust
              • Rust application example for connecting to OceanBase Cloud
              • SeaORM example for connecting to OceanBase Cloud
            • ruby
              • ActiveRecord sample application for OceanBase Cloud
              • Connect to OceanBase Cloud by using mysql2
              • Connect to OceanBase Cloud by using Sequel
          • Use database connection pool
            • Database connection pool configuration
            • Connect to OceanBase Cloud by using a Tomcat connection pool
            • Connect to OceanBase Cloud by using a C3P0 connection pool
            • Connect to OceanBase Cloud by using a Proxool connection pool
            • Connect to OceanBase Cloud by using a HikariCP connection pool
            • Connect to OceanBase Cloud by using a DBCP connection pool
            • Connect to OceanBase Cloud by using Commons Pool
            • Connect to OceanBase Cloud by using a Druid connection pool
        • Oracle compatible mode
          • Overview
          • Get connection string
            • Overview
            • Connect to a database by using AWS PrivateLink
            • Access a database by using an Azure private network connection
            • Connect using AWS VPC peering
            • Connect using Google Cloud Private Service Connect
            • Connect using Huawei Cloud VPC Endpoint
            • Connect using a public IP address
          • Connect with clients
            • Connect to OceanBase Cloud by using OBClient
            • Connect to OceanBase Cloud by using Client ODC
          • Connect with drivers
            • Java
              • Connect to OceanBase Cloud using OceanBase Connector/J
              • Connect to OceanBase Cloud by using Spring Boot
              • SpringBatch application example for connecting to OceanBase Cloud
              • Connect to OceanBase Cloud using Spring JDBC
              • Connect to OceanBase Cloud by using Spring Data JPA
              • Connect to OceanBase Cloud by using Hibernate
              • Use MyBatis to connect to OceanBase Cloud
              • Use JFinal to connect to OceanBase Cloud
            • Python
              • Python Driver for Oracle Mode
            • C
              • Connect to OceanBase Cloud using OceanBase Connector/C
              • Connect to OceanBase Cloud using OceanBase Connector/ODBC
              • Use SqlSugar to connect to OceanBase Cloud
          • Use database connection pool
            • Database connection pool configuration
            • Sample program that uses a Tomcat connection pool to connect to OceanBase Cloud
            • C3P0 connection pool connects to OceanBase Cloud
            • Connect to OceanBase Cloud using Proxool connection pool
            • Sample program that uses HikariCP to connect to OceanBase Cloud
            • Use DBCP connection pool to connect to OceanBase Cloud
            • Connect to OceanBase Cloud by using Commons Pool
            • Connect to OceanBase Cloud by using a Druid connection pool
      • Developer guide
        • MySQL compatible mode
          • Plan database objects
            • Create a database
            • Create a table group
            • Create a table
            • Create an index
            • Create an external table
          • Write data
            • Insert data
            • Update data
            • Delete data
            • Replace data
            • Generate test data in batches
          • Read data
            • Single-table queries
            • Join tables
              • INNER JOIN queries
              • FULL JOIN queries
              • LEFT JOIN queries
              • RIGHT JOIN queries
              • Subqueries
              • Lateral derived tables
            • Use operators and functions in queries
              • Use arithmetic operators in queries
              • Use numerical functions in queries
              • Use string concatenation operators in queries
              • Use string functions in queries
              • Use datetime functions in queries
              • Use type conversion functions in queries
              • Use aggregate functions in queries
              • Use NULL-related functions in queries
              • Use the CASE conditional operator in queries
              • Use the SELECT ... FOR UPDATE statement to lock query results
              • Use the SELECT ... LOCK IN SHARE MODE statement to lock query results
            • Use a DBLink in queries
            • Set operations
          • Manage transactions
            • Overview
            • Start a transaction
            • Savepoints
              • Mark a savepoint
              • Roll back a transaction to a savepoint
              • Release a savepoint
            • Commit a transaction
            • Roll back a transaction
        • Oracle compatible mode
          • Plan database objects
            • Create a table group
            • Create a table
            • Create an index
            • Create an external table
          • Write data
            • Insert data
            • Update data
            • Delete data
            • Replace data
            • Generate test data in batches
          • Read data
            • Single-table queries
            • Join tables
              • INNER JOIN queries
              • FULL JOIN queries
              • LEFT JOIN queries
              • RIGHT JOIN queries
              • Subqueries
              • Lateral derived tables
            • Use operators and functions in queries
              • Use arithmetic operators in queries
              • Use numerical functions in queries
              • Use string concatenation operators in queries
              • Use string functions in queries
              • Use datetime functions in queries
              • Use type conversion functions in queries
              • Use aggregate functions in queries
              • Use NULL-related functions in queries
              • Use CASE functions in queries
              • Use the SELECT ... FOR UPDATE statement to lock query results
            • Use a DBLink in queries
            • Set operations
          • Manage transactions
            • Overview
            • Start a transaction
            • Savepoints
              • Mark a savepoint
              • Roll back a transaction to a savepoint
            • Commit a transaction
            • Roll back a transaction
      • Manage instances
        • Manage instances
          • View the instance list
          • Instance overview
          • Stop and restart instances
          • Unit migration
        • Manage tenants
          • Tenant overview
          • Create a tenant
          • Modify tenant specifications
          • Modify tenant names
          • Add an endpoint
          • Resource isolation
            • Overview
            • Manage resource groups
              • Create a resource group
              • View a resource group
              • Edit a resource group
              • Delete a resource group
            • Manage isolation rules
              • Create an isolation rule
              • View isolation rules
              • Edit an isolation rule
              • Delete a quarantine rule
          • Modify primary zone
          • Modify the maximum number of connections for a tenant proxy
          • Enable the AI function built-in AI models
          • Monitor tenant performance
            • Overview
            • View performance and SQL monitoring details
            • View transaction monitoring details
            • View storage and cache monitoring details
            • View Binlog service monitoring
            • Customize a monitoring dashboard for a tenant
          • Diagnostics
            • Real-time diagnostics
              • SQL diagnostics
                • Top SQL
                • Slow SQL
                • Suspicious SQL
                • High-risk SQL
              • SQL audit
          • Manage tenant parameters
            • Manage tenant parameters
            • Parameters for tenants
            • Parameter template overview
          • Delete a tenant
          • Manage databases and accounts
            • Create accounts
            • Manage accounts
            • Create a database (MySQL compatible mode)
            • Manage databases (MySQL compatible mode)
        • Monitor instance performance
          • Overview
          • Monitor the performance of databases in an instance
          • Monitor multidimensional metrics of an instance
          • Monitor the performance of hosts in an instance
          • Monitor database proxy
          • Monitor database proxy hosts
          • Monitor cross-cloud network performance
          • Customize a monitoring dashboard for an instance
        • Manage major compactions
          • Initiate a major compaction
          • View compaction records
          • Update time for compactions
        • Manage instance parameters
          • Manage parameters
          • Parameters for cluster instances
        • Change instance configurations
          • Set storage auto-scaling
          • View history of configuration changes
          • Change configuration
          • Switch the deployment mode
        • Manage standby instances
          • Overview
          • Create a standby instance
          • Create a cross-cloud standby instance
          • View details of primary and standby instances
          • Configure global endpoint
          • Enable automatic forwarding for write requests of standby databases
          • Primary-standby instance switchover
          • Initiate failover
          • Detach a standby instance
          • Release a standby instance
        • Release an instance
        • Database proxy
          • Overview
          • Manage database proxy
          • Direct load
        • Manage alerts
          • Overview
          • Manage alert rules
            • Create an alert rule
            • View an alert rule
            • Edit an alert rule
            • Delete an alert rule
          • View alert history
          • Manage alert templates
            • Create a trigger condition template
            • View an alert template
            • Edit an alert template
            • Copy an alert rule template
            • Delete an alert template
          • Manage muting rules
            • Create an alert muting rule
            • View an alert muting rule
            • Edit an alert muting rule
            • Delete an alert muting rule
          • Manage alert notification templates
            • Create an alert notification template
            • View an alert notification template
            • Edit an alert notification template
            • Copy an alert notification template
            • Delete an alert notification template
          • Manage alert contacts
            • Add an alert contact
            • Add an alert contact group
            • View an alert contact
            • Edit an alert contact
            • Delete an alert contact
            • Obtain a webhook URL
          • Monitoring metrics for alerts
        • Backup and restore
          • Overview
          • Backup strategy
          • Initiate a backup immediately
          • Data backup
          • Initiate a restore
          • Data restore
          • Restore data from the instance recycle bin
        • Diagnostics
          • View performance monitoring data
          • Capacity diagnostics
          • One-click diagnostics
            • Initiate one-click diagnostics
            • View one-click diagnostic report
              • Exceptions
              • Real-time diagnostics
              • Optimization suggestions
              • Capacity management
              • Security management
          • Real-time diagnostics
            • SQL diagnostics
              • Top SQL
              • Slow SQL
              • Suspicious SQL
              • High-risk SQL
              • SQL details
              • SQL monitoring metrics list
            • Session management
              • Session management
            • Request analysis
              • Request analysis
          • Root cause diagnostics
            • Exception handling
            • Enable system autonomy
          • SQL audit
          • Materialized view analysis
          • Optimization center
            • Optimization suggestions
            • Manage active outlines
            • SQL review
            • View the optimization history
        • Manage read-only replicas
          • Overview
          • Instance read-only replicas
            • Add a read-only replica to an instance
            • View read-only replicas of an instance
            • Manage read-only replicas of an instance
            • Delete a read-only replica of an instance
          • Tenant read-only replicas
            • Add a read-only replica to a tenant
            • View read-only replicas of a tenant
            • Manage read-only replicas of a tenant
            • Delete a read-only replica of a tenant
        • Manage tags
        • Manage JVM-dependent services
      • Data source management
        • Connect via private network
          • Google Cloud
        • Connect via public network
          • Google Cloud
      • Overview of data source management
      • Data lifecycle management
        • Overview
        • Archive data
        • Clean up data
        • Data archiving configurations
      • Manage recycle Bin
        • Instance recycle bin
        • Manage databases and tables in recycle bin
          • Overview
          • Instance-level recycle bin
          • Tenant-level recycle bin
    • Work with analytical instances
      • Overview
      • Core features
      • Connect to an instance
        • Overview
        • Get connection string
          • Overview
          • Connect using AWS PrivateLink
          • Connect using Huawei Cloud VPC Endpoint
          • Connect using a public IP address
        • Connect with clients
          • Connect to OceanBase Cloud by using Client ODC
          • Connect to OceanBase Cloud by using a MySQL client
          • Connect to OceanBase Cloud by using OBClient
        • Connect with drivers
          • Java
            • Connect to OceanBase Cloud by using Spring Boot
            • Connect to OceanBase Cloud by using Spring Batch
            • Connect to OceanBase Cloud by using Spring Data JDBC
            • Connect to OceanBase Cloud by using Spring Data JPA
            • Connect to OceanBase Cloud by using Hibernate
            • Connect to OceanBase Cloud by using MyBatis
            • Connect to OceanBase Cloud using MySQL Connector/J
          • Python
            • Connect to OceanBase Cloud by using mysqlclient
            • Connect to OceanBase Cloud by using PyMySQL
            • Connect to OceanBase Cloud using MySQL Connector/Python
          • C
            • Connect to OceanBase Cloud using MySQL Connector/C
          • Go
            • Connect to OceanBase Cloud using Go-SQL-Driver/MySQL
          • PHP
            • Connect to OceanBase Cloud using PHP
        • Use database connection pool
          • Database connection pool configuration
          • Connect to OceanBase Cloud by using a Tomcat connection pool
          • Connect to OceanBase Cloud by using a C3P0 connection pool
          • Connect to OceanBase Cloud by using a Proxool connection pool
          • Connect to OceanBase Cloud by using a HikariCP connection pool
          • Connect to OceanBase Cloud by using a DBCP connection pool
          • Connect to OceanBase Cloud by using Commons Pool
          • Connect to OceanBase Cloud by using a Druid connection pool
      • Create an instance
      • Data table design
        • Table overview
        • Best practices
          • Unit 1: Best practices for optimizing storage structures and query performance
          • Unit 2: Best practices for creating special indexes
      • Export data
      • OceanBase data processing
      • Query acceleration
        • Statistics
        • Materialized views for query acceleration
        • Select a query parallelism level
      • Manage instances
        • Instance overview
        • Change configuration
        • Set storage auto-scaling
        • Modify primary zone
        • Manage parameters
        • Backup and restore
          • Backup overview
          • Backup strategies
          • Immediate backup
          • Data Backup
          • Initiate restore
          • Data restore
        • Monitor instance performance
          • Overview
          • Monitor the performance of databases in an instance
          • Monitor the performance of hosts in an instance
        • Manage major compactions
          • Initiate a major compaction
          • View compaction records
          • Update time for compactions
        • Database proxy
          • Overview
          • Manage database proxy
          • Direct load
        • Manage alerts
          • Overview
          • Manage alert rules
            • Create an alert rule
            • View an alert rule
            • Edit an alert rule
            • Delete an alert rule
          • View alert history
          • Manage alert templates
            • Create a trigger condition template
            • View an alert template
            • Edit an alert template
            • Copy an alert template
            • Delete an alert template
          • Manage muting rules
            • Create an alert muting rule
            • View an alert muting rule
            • Edit an alert muting rule
            • Delete an alert muting rule
          • Manage alert notification templates
            • Create an alert notification template
            • View an alert notification template
            • Edit an alert notification template
            • Copy an alert notification template
            • Delete an alert notification template
          • Manage alert contacts
            • Add an alert contact
            • Add an alert contact group
            • View an alert contact
            • Edit an alert contact
            • Delete an alert contact
            • Obtain a webhook URL
          • Monitoring metrics for alerts
        • Diagnostics
          • View performance monitoring data
          • Capacity diagnostics
          • Real-time diagnostics
            • SQL diagnostics
              • Top SQL
              • Slow SQL
              • Suspicious SQL
              • High-risk SQL
              • SQL details
              • SQL monitoring metrics list
            • Session management
              • Session management
            • Optimization management
              • Manage active outlines
              • View the optimization history
            • Request analysis
              • Request analysis
        • Stop and restart instances
        • Release instances
        • Manage databases and accounts
          • Create and manage accounts
          • Create a database
          • Manage databases
        • Manage tags
      • Overview of data source management
      • Data lifecycle management
        • Archive data
        • Clean up data
      • Performance diagnosis and tuning
        • Use the DBMS_XPLAN package for performance diagnostics
        • Use the GV$SQL_PLAN_MONITOR view for performance analysis
        • Views related to AP performance analysis
      • Performance testing
      • Product integration
      • Manage recycle Bin
        • View instance recycle bin
        • Manage databases and tables in recycle bin
          • Overview
          • Instance recycle bin
    • Work with Key-Value instances
      • Try out Key-Value instances
        • Create an instance
        • Create a tenant
        • Create an account for a database user
        • OBKV HBase data operation examples
      • Use Table model
        • Create an instance
        • Manage instances
          • Manage instances
            • View the instance list
            • Instance overview
            • Stop and restart instances
            • Release an instance
          • Manage tenants
            • Create a tenant
            • Modify tenant specifications
            • Modify tenant names
            • Delete a tenant
            • Tenant overview
            • Resource isolation
              • Overview
              • Manage resource groups
                • Create a resource group
                • View a resource group
                • Edit a resource group
                • Delete a resource group
              • Manage isolation rules
                • Create an isolation rule
                • View isolation rules
                • Edit an isolation rule
                • Delete a quarantine rule
            • Monitor tenant performance
              • Overview
              • View performance and SQL monitoring details
              • View transaction monitoring details
              • View storage and cache monitoring details
              • OBKV-Table
              • Customize a monitoring dashboard for a tenant
            • Diagnostics
              • Top SQL
            • Manage tenant parameters
              • Manage tenant parameters
              • Parameters for tenants
            • Manage databases and accounts
              • Create and manage accounts
              • Create a database
              • Manage databases
            • Modify primary zone
          • Monitor instance performance
            • Overview
            • Monitor the performance of databases in an instance
            • Monitor multi-dimensional metrics of an instance
            • Monitor the performance of hosts in a cluster
            • Customize monitoring dashboards for an instance
          • Manage major compactions
            • Initiate major compactions
            • View compaction records
            • Update time for compactions
          • Manage instance parameters
            • Parameter management overview
            • Parameters for cluster instances
          • Change instance configurations
            • Set storage auto-scaling
            • View history of configuration changes
            • Change configuration
            • Switch the deployment mode
          • Database proxy
            • Overview
            • Manage database proxy
          • Manage alerts
            • Overview
            • Manage alert rules
              • Create an alert rule
              • View an alert rule
              • Edit an alert rule
              • Delete an alert rule
            • View alert history
            • Manage alert templates
              • Trigger condition template management
              • Create an alert template
              • View an alert template
              • Edit an alert template
              • Copy an alert template
              • Delete an alert template
            • Manage muting rules
              • Create an alert muting rule
              • View an alert muting rule
              • Edit an alert muting rule
              • Delete an alert muting rule
            • Manage alert contacts
              • Add an alert contact
              • Add an alert contact group
              • View an alert contact
              • Edit an alert contact
              • Delete an alert contact
              • Obtain a webhook URL
            • Monitoring metrics for alerts
          • Backup and restore
            • Backup overview
            • Backup strategies
            • Immediate backup
            • Data backup
            • Initiate restore
            • Data restore
          • Diagnostics
            • View performance monitoring data
            • Top SQL
            • Capacity diagnostics
            • Request analysis
          • Manage recycle Bin
            • View instance recycle bin
            • Manage databases and tables in recycle bin
              • Overview
              • Instance-level recycle bin
              • Tenant-level recycle bin
          • Manage tags
      • Use HBase model
        • OBKV-HBase Overview
        • Create an instance
        • Develop in HBase model
          • Connect to an instance by using the OBKV-HBase client
        • Manage instances
          • Manage instances
            • View the instance list
            • Instance overview
            • Stop and restart instances
            • Release an instance
          • Manage tenants
            • Create a tenant
            • Modify tenant specifications
            • Modify tenant names
            • Delete a tenant
            • Tenant overview
            • Resource isolation
              • Overview
              • Manage resource groups
                • Create a resource group
                • View a resource group
                • Edit a resource group
                • Delete a resource group
              • Manage isolation rules
                • Create an isolation rule
                • View isolation rules
                • Edit an isolation rule
                • Delete a quarantine rule
            • Monitor tenant performance
              • Overview
              • View performance and SQL monitoring details
              • View transaction monitoring details
              • View storage and cache monitoring details
              • OBKV-HBase
              • Customize a monitoring dashboard for a tenant
            • Diagnostics
              • Top SQL
            • Manage tenant parameters
              • Manage tenant parameters
              • Parameters for tenants
            • Manage databases and accounts
              • Create and manage accounts
              • Create a database
              • Manage databases
            • Modify primary zone
          • Monitor instance performance
            • Overview
            • Monitor the performance of databases in an instance
            • Monitor multi-dimensional metrics of an instance
            • Monitor the performance of hosts in a cluster
            • Customize monitoring dashboards for an instance
          • Manage major compactions
            • Initiate major compactions
            • View compaction records
            • Update time for compactions
          • Manage instance parameters
            • Parameter management overview
            • Parameters for cluster instances
          • Change instance configurations
            • Set storage auto-scaling
            • View history of configuration changes
            • Change configuration
            • Switch the deployment mode
          • Database proxy
            • Overview
            • Manage database proxy
          • Manage alerts
            • Overview
            • Manage alert rules
              • Create an alert rule
              • View an alert rule
              • Edit an alert rule
              • Delete an alert rule
            • View alert history
            • Manage alert templates
              • Trigger condition template management
              • Create an alert template
              • View an alert template
              • Edit an alert template
              • Copy an alert template
              • Delete an alert template
            • Manage muting rules
              • Create an alert muting rule
              • View an alert muting rule
              • Edit an alert muting rule
              • Delete an alert muting rule
            • Manage alert contacts
              • Add an alert contact
              • Add an alert contact group
              • View an alert contact
              • Edit an alert contact
              • Delete an alert contact
              • Obtain a webhook URL
            • Monitoring metrics for alerts
          • Backup and restore
            • Backup overview
            • Backup strategies
            • Immediate backup
            • Data backup
            • Initiate restore
            • Data restore
          • Diagnostics
            • View performance monitoring data
            • Top SQL
            • Capacity diagnostics
            • Request analysis
          • Manage recycle Bin
            • View instance recycle bin
            • Manage databases and tables in recycle bin
              • Overview
              • Instance-level recycle bin
              • Tenant-level recycle bin
          • Manage tags
        • Overview of data source management
        • Performance test
      • Connect Key-Value instances
        • Overview
        • Connect using Huawei Cloud VPC Endpoint
        • Connect using a public IP address
  • AI Features
    • AI services
      • Overview of AI service
      • Quick start
      • Manage AI API keys
      • Use AI models
      • Use Claude Code with OceanBase MaaS
      • Use Codex CLI and Codex App with OceanBase MaaS
      • Use the memory feature
      • AI APIs
        • Access guide
        • AI service APIs
          • AI API list
          • Anthropic compatible APIs
            • List Anthropic models
            • Create a message
            • Create a message (default base URL)
          • OpenAI compatible APIs
            • List models
            • Create chat completion
            • Create embedding
            • Rerank
            • Reranks
            • Create response
          • Vertex AI compatible APIs
            • Generate content
            • Stream generate content
          • Image and video generation APIs
            • Create an image generation task
            • Create a video generation task
            • Retrieve task status
          • Image model APIs
            • gpt-image-2 text-to-image
            • gpt-image-2 image editing
            • gemini-3-pro-image text-to-image
            • gemini-3-pro-image image-to-image / image editing
          • OpenAI compatible batches and files APIs
            • Upload file
            • List files
            • Retrieve file
            • Delete file
            • Get file content
            • Get file content (POST)
            • Create batch
            • List batches
            • openai-compatible-apis
            • Retrieve batch (POST)
            • Cancel batch
          • Memory APIs
            • listSpaces - Paginated list of memory spaces
            • createSpace - Create a memory space
            • getSpace - Get details of a specified memory space
            • updateSpace - Update the name and description of a space
            • deleteSpace - Delete a space
            • extractMemories - Extract memories from dialogue messages
            • listMemories - List memories in a space
            • addMemory - Add a memory directly
            • getMemory - Retrieve a single memory
            • updateMemory - Update a single memory
            • deleteMemory - Delete a single memory
            • distillMemory - Distill experiences from conversations
            • searchExperiences - Search for experiences
            • getExperience - Retrieve a single experience
            • deleteExperience - Delete a single experience
            • feedbackExperiences - Submit feedback on experiences
            • setExperienceObsolescence - Set the obsolete status of an experience
            • combinedSearch - Combined search for memories and experiences
      • Built-in models
    • OceanBase OAgent
      • What is OceanBase OAgent?
      • Quick start with OceanBase OAgent
      • Configure a channel
      • Set skills
      • View OceanBase OAgent token usage
  • Migrations
    • Data migration and import solutions
    • Data assessment and migration quick start
    • Assess compatibility
      • Overview
      • Perform online assessment
      • Perform offline assessment
      • Manage compatibility assessment tasks
        • View a compatibility assessment task
        • View and download a compatibility assessment report
        • Stop a compatibility assessment task
        • Delete a compatibility assessment task
      • Obtain files for upload
      • Configure PrivateLink
      • Add an IP address to an allowlist
    • Data source management
      • Create a data source
      • Manage data sources
      • User privileges
        • User privileges for compatibility assessment
        • User privileges for data migration
        • User privileges for performance assessment
        • User privileges for data archiving
        • User privileges for data cleanup
      • Connect via private network
        • AWS
        • Huawei Cloud
        • Alibaba Cloud
        • Azure
        • Private IP address range
      • Connect via public network
        • AWS
        • Huawei Cloud
        • Alibaba Cloud
        • Azure
      • Connect via VPC peering
        • Configure an AWS data service peering connection
        • Configure a Huawei Cloud data service peering connection
        • Configure an Alibaba Cloud data service peering connection
        • Configure a Google Cloud data service peering connection
    • Migrate data
      • Overview
      • Migrations specification
      • Purchase a data migration instance
      • Migrate data from a MySQL database to the MySQL-compatible mode of OceanBase Database
      • Migrate data from OceanBase Database in MySQL-compatible mode to a MySQL database
      • Data migration between tenants of OceanBase Database in the same compatibility mode
      • Migrate data between OceanBase database tenants of different compatibility modes
      • Migrate data from an Oracle database to an Oracle-compatible tenant of OceanBase Database
      • Migrate data from an Oracle-compatible tenant of OceanBase Database to an Oracle database
      • Configure a two-way synchronization task
      • Migrate data from OceanBase Database to Kafka
      • Migrate data from a TiDB database to the MySQL-compatible mode of OceanBase Database
      • Migrate incremental data from OceanBase Database in MySQL-compatible mode to TiDB Database
      • Migrate data from a PostgreSQL database to OceanBase Database
      • Migrate incremental data from OceanBase Database to PostgreSQL Database
      • Migrate data from a Lindorm/HBase database to the HBase API compatible mode of OceanBase Database
      • Migrate incremental data from OceanBase Database in HBase API compatibility mode to a Lindorm/HBase database
      • Migrate data from OceanBase Database to RocketMQ
      • Migrate data from OceanBase Database to DataHub
      • Migrate data from OceanBase Database in MySQL mode to ADB
      • Migrate data from PolarDB-X 2.0 to OceanBase Database in MySQL mode
      • Manage data migration tasks
        • View details of a data migration task
        • Rename a data migration task
        • View and modify migration objects
        • View and modify migration parameters
        • Configure alert monitoring
        • Manage data migration tasks by using tags
        • Intelligent diagnosis
        • Start, stop, and resume a data migration task
        • Clone a data migration task
        • Terminate and release a data migration task
      • Features
        • Custom DML/DDL configurations
        • DDL synchronization scope
        • Use SQL conditions to filter data
        • Rename a migration object
        • Set an incremental synchronization timestamp
        • Instructions on schema migration
        • Configure and modify matching rules
        • Wildcard rules
        • Import migration objects
        • Download conflict data
        • Change a topic
        • Column filtering
        • Data formats
        • Partition settings
      • Authorize an Alibaba Cloud account
      • SQL statements for querying table objects
      • Online DDL tools
      • Create a trigger
      • Modify the log level of a self-managed PostgreSQL instance
      • Supported DDL statements for synchronization and their limitations
        • DDL synchronization from Aurora MySQL DB clusters to MySQL-compatible tenants of OceanBase Database
        • DDL synchronization from MySQL-compatible tenants of OceanBase Database to Aurora MySQL DB clusters
        • DDL synchronization between MySQL-compatible tenants of OceanBase Database
        • DDL synchronization from Oracle databases to Oracle-compatible tenants of OceanBase Database
        • DDL synchronization from Oracle-compatible tenants of OceanBase Database to Oracle databases
        • DDL synchronization between Oracle-compatible tenants of OceanBase Database
        • DDL synchronization from OceanBase databases to Kafka instances
    • Data subscription
      • Create a data subscription task
      • Manage data subscription tasks
        • View details of a data subscription task
        • Configure subscription information
        • Modify the name of a data subscription task
        • View and modify subscription objects
        • View data subscription parameters
        • Set up data subscription alerts
        • Start, stop, and resume data subscription tasks
        • Clone a data subscription task
        • Release a data subscription task
      • Manage private connections for data subscriptions
      • Configure consumer subscription
      • Message formats
    • Data validation
      • Overview
      • Create a data validation task
      • Manage data validation tasks
        • View details of a data validation task
        • View and modify validation objects
        • View and modify validation parameters
        • Manage data validation tasks with tags
        • Start, pause, and resume data validation tasks
        • Clone a data validation task
        • Release a data validation task
      • Features
        • Import validation objects
        • Rename the validation object
        • Filter objects by using SQL conditions
        • Configure the matching rules for the validation object
    • Assess performance
      • Overview
      • Obtain traffic files from a database instance
      • Create a full performance assessment task
      • Create an SQL file parsing task
      • Create an SQL file replay task
      • Manage performance assessment tasks
        • View the details of a performance assessment task
        • View a performance assessment report
        • Retry and stop a performance assessment task
        • Delete a performance assessment task
      • Obtain a database instance
      • Create an access key
    • Import data
      • Import data
      • Direct load
      • Supported file formats and encoding formats for Data Import
      • Sample data introduction
    • Binlog service
      • Overview
      • Purchase the Binlog service
      • Manage Binlog service
        • View details of the Binlog service
        • Change configuration
        • Modify the auto-scaling strategy for storage space
        • Modify the elasticity strategy for compute units
        • Disable the Binlog service
    • Upgrade assistant
  • Security
    • OceanBase Cloud account settings
      • Manage personal account information
      • Multi-factor authentication
      • Organization authentication
        • Enable organization authentication
        • Configure IdP
      • Manage AccessKeys
      • Time zone settings
      • Manage cloud marketplace accounts
      • Account audit
    • Organizations and projects
      • Overview
      • Manage organization information
      • Project management
        • Manage projects
        • Cross-project bidirectional authorization
        • AI settings
        • Manage object storage configurations
        • Subscribe to project messages
      • Manage members
      • Permissions for roles
      • Cost management
        • Overview
        • Cost details
        • Manage cost units
      • Operation audit
    • Database accounts and privileges
      • Account privileges
      • Authorize cloud vendor accounts
      • AWS KMS key management
      • Support access control
    • Security and encryption
      • Set allowlist groups
      • SSL encryption
      • Transparent Data Encryption (TDE)
    • Monitoring dashboard
    • Events
    • Support plans
      • Overview of OceanBase Cloud support plans
      • Subscribe to and manage support plans
  • SQL Console
    • Overview
    • Access SQL Console
    • SQL editing and execution
    • PL compilation
    • Result set editing
    • Execution analysis
    • Database object management
      • Create a table
      • Create a view
      • Create a function
      • Create a stored procedure
      • Create a program package
      • Create a trigger
      • Create a type
      • Create a sequence
      • Create a synonym
    • Session variable management
    • Functional keys in SQL Console
    • Intelligent SQL development
  • Integrations
    • Overview
    • Schema evolution
      • Liquibase
      • Flyway
    • Data ingestion
      • Canal
      • dbt
      • Debezium
      • Flink
      • Glue
      • Informatica Cloud
      • Kafka
      • Maxwell
      • SeaTunnel
      • DataWorks
      • NiFi
    • SQL development
      • DataGrip
      • DBeaver
      • Navicat
      • TablePlus
    • Orchestration
      • DolphinScheduler
      • Linkis
      • Airflow
    • Visualization
      • Grafana
      • Power BI
      • Quick BI
      • Superset
      • Tableau
    • Observability
      • Datadog
      • Prometheus
    • Database management
      • Bytebase
    • AI
      • LlamaIndex
      • Dify
      • LangChain
      • Tongyi Qianwen
      • OpenAI
      • n8n
      • Trae
      • SpringAI
      • Cline
      • Cursor
      • Continue
      • Toolbox
      • CamelAI
      • Firecrawl
      • Hugging Face
      • Ollama
      • Google Gemini
      • Cloudflare Workers AI
      • Qoder
      • OpenCode
      • Claude Code
      • GitHub Copilot
      • Codex
      • Jina AI
      • Augment Code
      • Claude Code
      • Kiro
    • Development tools
      • Cloudflare Workers
      • Vercel
  • Best practices
    • Best practices for achieving high availability through cross-cloud active-active deployment
    • High availability through cross-cloud primary-standby databases (1:1)
    • High availability through cross-cloud primary-standby databases (1:n)
    • High host CPU usage
    • Best practices for read/write splitting in OceanBase Cloud
    • Best practices for migrating data from AWS RDS to OceanBase Cloud
  • References
    • System architecture
    • System management
    • Database object management
    • Database design and specification constraints
    • SQL reference
    • System views
    • Parameters and system variables
    • Error codes
    • Performance tuning
    • Open API References
      • Overview of Open APIs
      • Service endpoints
      • Using API
      • Open APIs
        • Cluster management
          • DescribeInstances
          • DescribeInstance
          • CreateInstance
          • DeleteInstance
          • ModifyInstanceName
          • describe-node-options
          • StopCluster
          • StartCluster
          • ModifyInstanceSpec
          • DescribeInstanceTopology
          • DescribeReadonlyInstances
          • CreateReadonlyInstance
          • ModifyReadonlyInstanceSpec
          • ModifyReadonlyInstanceDiskSize
          • ModifyReadonlyInstanceNodeNum
          • DeleteReadonlyInstance
          • DescribeInstanceAvailableRoZones
          • DescribeInstanceParameters
          • UpdateInstanceParameters
          • DescribeInstanceParametersHistory
          • ModifyInstanceTagList
          • ModifyInstanceNodeNum
          • DescribeInstanceAnomalyEvents
          • DescribeOasClusterAnomalySqlList
          • DescribeOasClusterSlowSQLList
          • DescribeInstanceSqlAuditServiceInfo - Query SQL Audit Service Information
          • DescribeProxyClusterForInstance - Query ODP clusters associated with an instance
          • SwitchoverInstance - Perform a primary/standby switchover
        • Tenant management
          • DescribeTenants
          • DescribeTenant - Query Information of a Specified Tenant in a Specified Cluster
          • CreateTenants
          • DeleteTenants
          • ModifyTenantName
          • ModifyTenant
          • ModifyTenantUserDescription
          • ModifyTenantUserStatus
          • GetTenantCreateConstraints
          • ModifyTenantPrimaryZone
          • GetTenantCreateCpuConstraints
          • GetTenantCreateMemConstraints
          • GetTenantModifyCpuConstraints
          • GetTenantModifyMemConstraints
          • CreateTenantSecurityIpGroup
          • DescribeTenantSecurityIpGroups
          • ModifyTenantSecurityIpGroup
          • DeleteTenantSecurityIpGroup
          • DescribeTenantPrivateLink
          • DeletePrivatelinkConnection
          • CreatePrivatelinkService
          • ConnectPrivatelinkService
          • AddPrivatelinkServiceUser
          • BatchKillProcessList
          • DescribeProcessStatsComposition
          • DescribeTenantAddressInfo - Query Tenant Address Information
          • DescribeTenantAvailableRoZones
          • ModifyTenantReadonlyReplica
          • DescribeTenantParameters
          • UpdateTenantParameters
          • DescribeTenantParametersHistory
          • ModifyTenantTagList
          • CreateReadonlyPrivatelink
          • CreateReadwritePrivatelink
          • DescribeTenantPublicAddress - Query Tenant Public IP Address
          • DescribeTenantSqlAuditServiceInfo - Query SQL Audit Service Information for a Tenant
        • Tenant user management
          • CreateTenantUser
          • DescribeTenantUsers
          • DeleteTenantUsers
          • ModifyTenantUserPassword
          • ModifyTenantUserRoles
        • Database management
          • CreateDatabase
          • DescribeDatabases
          • DeleteDatabases
          • ModifyDatabaseUserRoles
          • DescribeTableSchema
        • Backup and restore
          • DescribeDataBackupSet
          • DescribeRestorableTenants
          • ModifyBackupStrategy
          • CreateTenantRestoreTask
          • CreateDataBackupTask
          • DescribeOneDataBackupSet
          • CreateBackupSetDownloadLink - Create a backup set download link
          • DeleteBackupSetDownloadTask - Delete a backup set download task
          • DescribeBackupSetDownloadLink - Query a backup set download link
          • DescribeBackupStrategy - Query backup strategy
        • Database proxy management
          • CreateTenantAddress
          • CreateTenantSingleTunnelSLBAddress
          • DeleteTenantAddress
          • DescribeTenantAddress
          • ModifyOdpClusterSpec
          • ModifyTenantAddressPort
          • ModifyTenantAddressDomainPrefix
          • ConfirmPrivatelinkConnection
          • DescribeTenantAddressInfo
        • Data source management
          • ListDataSources - List data sources
          • CreateDataSource - Create a data source
          • DeleteDataSource - Delete a data source
        • OMS project management
          • DescribeProject - Query project details
          • CreateProject - Create a project
          • DeleteProject - Delete a project
          • DescribeProjectSteps - Query project steps
          • StartProject - Start a project
          • StopProject - Stop a project
          • ResumeProject - Resume a project
          • ReleaseProject - Release project resources
          • UpdateProjectConfig - Update project configuration
          • ListProjectModifyRecords - List project modification records
          • CreateProjectModifyRecords - Create modification records (add or remove tables)
          • CancelProjectModifyRecord - Cancel a modification record
          • RetryProjectModifyRecords - Retry a modification
          • StopProjectModifyRecords - Terminate a modification
          • GetModifyRecord - Query modification record details
          • DescribeTransferMapping - Query transfer object mappings
        • Monitoring management
          • DescribeTenantMetrics
          • DescribeMetricsData
          • CreatePrometheusIntegration - Create a Prometheus Monitoring Integration
          • DeletePrometheusIntegration - Delete Prometheus Monitoring Integration
          • ListPrometheusIntegration - Query Prometheus Monitoring Integration List
          • DescribeNodeMetrics
        • Diagnostic management
          • DescribeOasTopSQLList
          • DescribeOasAnomalySQLList
          • DescribeOasSlowSQLList
          • DescribeOasSQLText
          • DescribeSqlAudits
          • DescribeOutlineBinding
          • DescribeSampleSqlRawTexts
          • DescribeSQLTuningAdvices
          • DescribeOasSlowSQLSamples
          • DescribeOasSQLTrends
          • DescribeOasSQLPlanGroup
          • DescribeRcaRecord
          • DescribeTopSQLComparision
          • DescribeSessionStatsGroupBySqlId
          • DescribeIndexes
          • DescribeOasHighRiskSQL
        • Security management
          • CreateSecurityIpGroup
          • DescribeInstanceSSL
          • ModifyInstanceSSL
          • DescribeTenantEncryption
          • ModifyTenantEncryption
          • ModifySecurityIps
          • DeleteSecurityIpGroup
          • DescribeTenantSecurityConfigs
          • DescribeInstanceSecurityConfigs
        • Tag management
          • DescribeTags
          • CreateTags
          • UpdateTag
          • DeleteTag
        • Historical event management
          • DescribeOperationEvents
        • AI service management
          • CreateAIServiceAPIKey
          • DeleteAIServiceAPIKey
          • ListAIServiceAPIKeys
      • Open API FAQ
      • Differences between ApsaraDB for OceanBase APIs and OceanBase Cloud APIs
    • Download OBClient
      • Download OBClient
      • Download OceanBase Connector/J
      • Download client ODC
      • Download OceanBase Connector/ODBC
      • Download OBClient Libs
    • Performance Tests
      • OLTP performance test: Sysbench benchmark
      • OLAP performance test: TPC-H benchmark
      • OLTP performance test: TPC-C benchmark
    • Metrics References
      • Cluster database
      • Cluster hosts
      • Binlog service
      • Cross-cloud network channel connection
      • Performance and SQL
      • Transactions
      • Storage and caching
      • Proxy database
      • Proxy host
    • ODC User Guide
      • What is ODC?
        • What is ODC?
        • Limitations
      • Quick start
        • Client ODC
          • Overview
          • Install Client ODC
          • Use Client ODC
        • Web ODC
          • Overview
          • Use Web ODC
      • Data source management
        • Create a data source
        • Data sources and project collaboration
        • Database O&M
          • Session management
          • Global variable management
          • Recycle bin management
      • SQL development
        • Edit and execute SQL statements
        • Perform PL compilation and debugging
        • Edit and export the result set of an SQL statement
        • Execution analysis
        • Generate test data
        • System settings
        • Database objects
          • Table objects
            • Overview
            • Create a table
          • View objects
            • Overview
            • Create a view
            • Manage views
          • Materialized view objects
            • Overview
            • Create a materialized view
            • Manage materialized views
          • Function objects
            • Overview
            • Create a function
            • Manage functions
          • Stored procedure objects
            • Overview
            • Create a stored procedure
            • Manage stored procedures
          • Sequence objects
            • Overview
            • Create a sequence
            • Manage sequences
          • Package objects
            • Overview
            • Create a program package
            • Manage program packages
          • Trigger objects
            • Overview
            • Create a trigger
            • Manage triggers
          • Type objects
            • Overview
            • Create a type
            • Manage types
          • Synonym objects
            • Overview
            • Create a synonym
            • Manage synonyms
      • Import and export
        • Import schemas and data
        • Export schemas and data
      • Database change management
        • User permission management
          • Users and roles
          • Automatic authorization
          • User permission management
        • Project collaboration management
        • Risk levels, risk identification rules, and approval processes
        • SQL check specifications
        • SQL window specification
        • Database change management
        • Batch database change management
        • Online schema changes
        • Synchronize shadow tables
        • Schema comparison
      • Data lifecycle management
        • Partitioning plan management
          • Manage partitioning plans
          • Set partitioning strategies
          • Examples
        • SQL plan task
      • Data desensitization and auditing
        • Desensitize data
        • Operation records
      • Notification management
        • Overview
        • View notification records
        • Manage notification channel
          • Create a notification channel
          • View, edit, and delete a notification channel
          • Configure a custom channel
        • Manage notification rules
      • Best practices
        • Tips for SQL development
        • Explore ODC team workspaces
        • Understanding real-time SQL diagnostics for OceanBase AP
        • OceanBase historical database solutions
        • ODC SQL check for automatic identification of high-risk operations
        • Manage and modify sharded databases and tables via ODC
        • Data masking and control practices
        • Enterprise-level control and collaboration: Safeguard every database change
    • Data development
      • Overview
      • Workspace management
      • Worksheet management
      • Compute node pool management
      • Workflow management
      • Dashboard management
      • Manage Git repositories
      • SQL development
        • SQL editing and execution
        • Result set editing
        • Execution analysis
        • Database object management
          • Create a table
          • Create a view
          • Create a function
          • Create a stored procedure
        • Session variable management
        • Git integration
      • Sample datasets
      • Data development terms
  • Manage Billing
    • Access billing
    • View bills
      • View orders
    • View monthly bills
    • View payment details
    • Manage AI service billing
      • Usage monitoring
      • View API key records
      • Rate limits & quotas
    • Payment method
      • Use vouchers for payment
    • View invoices
  • Legal Agreements
    • OceanBase Cloud Services Agreement
    • AI Service Addendum
    • Service Level Agreement
    • OceanBase Data Processing Addendum
    • Service Level Agreement for OceanBase Cloud Migration Service
    • Historical agreements
      • Service Level Agreement for OceanBase Cloud Migration Service (Released March 20, 2026)

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Cloud

DescribeMetricsData

Last Updated:2026-09-22 07:23:31

Overview
API details
Constraints
Request path
Request parameters
Body
Response parameters
Examples
Request example
Response example
List of cluster monitoring metrics
Supported metrics for tenant monitoring

Overview

You can call this API to query the single- or multi-dimensional metrics of an OceanBase cluster.

API details

Constraints

The caller must have an AccessKey for accessing the APIs of OceanBase Cloud. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.

Request path

POST /api/v2/services/DescribeMetricsData

Request parameters

Body

Parameter
Type
Required
Description
Example value
instanceId string Yes The ID of the OceanBase instance. ob317v4uif****
startTime string Yes The start time of the metrics. The time must be in UTC and in the format of: YYYY-MM-DDThh:mm:ssZ. 2021-06-13T15:40:43Z
endTime string Yes The end time of the metrics. The time must be in UTC and in the format of: YYYY-MM-DDThh:mm:ssZ. 2021-09-13T15:40:43Z
metrics List Yes The name of the metric. toal_sessions_tenant
tenantIdList List No The list of tenant IDs. t4tx6u5tc****
nodeIdList List No The list of node IDs. i-0104c6fb57e6e****
labels string Yes A string that contains key-value pairs. The key and value are separated by : and the key-value pairs are separated by ,. For example: "app:OB,clusterId:ob*****,tenantId:t******,serverId:*****,zoneId:cn-hangzhou-j". The keys are fixed.
  • app: the type of the application. At present, only OceanBase is supported.
  • clusterId: the ID of the OceanBase instance.
  • tenantId: the ID of the OceanBase tenant.
  • zoneId: the ID of the zone.
  • serverId: the ID of the OBServer node.
app:OB,clusterId:ob***
groupByLabels string Yes The fields for grouping. Separate multiple fields with commas. For example: "app,clusterId,tenantId". app,clusterId
sortMetricKey string No The column for sorting. tps
sortOrder string No The sorting rule.
  • ASC: ascending.
  • DESC: descending.
DESC
limit string No The length of the data array returned after sorting. 5

Response parameters

Parameter
Type
Description
Example value
tenantId string The ID of the tenant. sys
data List The metrics of the tenant. [ {"sql_all_count":16.39, "timestamp":1698217920},{"sql_all_count":16.11,"timestamp":1698214980},{"sql_all_count":16.43,"timestamp":1698216900}],"clusterId":"ob568006pe74kg"}, ...... ]

Examples

Request example

curl  --digest   -u 'AccessKeyID:AccessKeySecret' \
  --request POST \
  --url   https://api-cloud.oceanbase.com/api/v2/services/DescribeMetricsData\
  -H 'X-Ob-Project-Id: <Project ID>' \
  --data \
'{"InstanceId":"obmt5344s5grrpcw","StartTime":"2023-10-24T20:51:40Z","EndTime":"2023-10-25T02:51:40Z","Metrics":"sql_all_rt,sql_delete_rt,sql_insert_rt,sql_other_rt,sql_replace_rt,sql_select_rt,sql_update_rt","Labels":"clusterId:obmt5344s5grrpcw,tenantId:obmt5344s5grrpcw","GroupByLabels":"clusterId,tenantId"}'

Note

  • A project ID uniquely identifies a project. For information about how to obtain the project ID of an instance, see Manage projects.
  • Make sure that the project ID corresponding to the specified instanceId is consistent with the specified project ID.

Response example

JSON format

{
    "Code":200,
    "Cost":91,
    "Data":[
        {
            "tenantId":"sys",
            "Data":[
                {
                    "sql_all_count":16.39,
                    "timestamp":1698217920
                },
                {
                    "sql_all_count":16.11,
                    "timestamp":1698214980
                },
                {
                    "sql_all_count":16.43,
                    "timestamp":1698216900
                }
            ],
            "clusterId":"ob****06pe74kg"
        },
        {
            "tenantId":"t****h898auo0",
            "Data":[

                {
                    "sql_all_count":0.0,
                    "timestamp":1698217920
                },
                {
                    "sql_all_count":0.0,
                    "timestamp":1698214980
                },
                {
                    "sql_all_count":0.0,
                    "timestamp":1698216900
                }
            ],
            "clusterId":"ob****06pe74kg"
        }
    ],
    "Deletable":false,
    "ErrorCode":"",
    "Message":"successful",
    "RequestId":"",
    "Success":true,
    "Trace":"6F95****-2961-4CEB-****-717E22A5****"
}

List of cluster monitoring metrics

Metric Name
Description
Unit
Supported Dimensions
sql_all_count The number of SQL statements processed per second. times/s ClusterId, ServerId
sql_delete_count The number of Delete statements processed per second. times/s ClusterId, ServerId
sql_insert_count The number of Insert statements processed per second. times/s ClusterId, ServerId
sql_replace_count The number of Replace statements processed per second. times/s ClusterId, ServerId
sql_select_count The number of Select statements processed per second. times/s ClusterId, ServerId
sql_update_count The number of Update statements processed per second. times/s ClusterId, ServerId
sql_all_rt The average time consumed in processing SQL statements. ms ClusterId, ServerId
sql_delete_rt The average time consumed in processing Delete statements. ms ClusterId, ServerId
sql_insert_rt The average time consumed in processing Insert statements. ms ClusterId, ServerId
sql_other_rt The average time consumed in processing other statements such as DDL, DCL, and DTL statements. ms ClusterId, ServerId
sql_replace_rt The average time consumed in processing Replace statements. ms ClusterId, ServerId
sql_select_rt The average time consumed in processing Select statements. ms ClusterId, ServerId
sql_update_rt The average time consumed in processing Update statements. ms ClusterId, ServerId
transaction_commit_count The number of transactions committed per second. times/s ClusterId, ServerId
transaction_count The number of transactions processed per second. times/s ClusterId, ServerId
transaction_rollback_count The number of transactions rolled back per second. times/s ClusterId, ServerId
transaction_timeout_count The number of transactions that timed out per second. times/s ClusterId, ServerId
transaction_commit_rt The average time consumed in committing a transaction. ms ClusterId, ServerId
transaction_rollback_rt The average time consumed in rolling back a transaction. ms ClusterId, ServerId
transaction_rt The average time consumed in processing a transaction. ms ClusterId, ServerId
active_session The number of active sessions. - ClusterId, ServerId
all_session The number of sessions. - ClusterId, ServerId
request_queue_time The time consumed in waiting for an SQL statement in the queue. μs ClusterId, ServerId
trans_commit_log_count The number of transaction logs committed per second. times/s ClusterId, ServerId
clog_trans_log_total_size The size of transaction logs committed per second. byte ClusterId, ServerId
io_count The number of I/O operations performed on SSStore per second. times/s ClusterId, ServerId
io_read_count The number of read operations performed on SSStore per second. times/s ClusterId, ServerId
io_write_count The number of write operations performed on SSStore per second. times/s ClusterId, ServerId
io_read_rt The average time consumed in reading data from SSStore. μs ClusterId, ServerId
io_rt The I/O time. μs ClusterId, ServerId
io_write_rt The average time consumed in writing data to SSStore. μs ClusterId, ServerId
io_read_size The amount of data read from SSStore per second. byte ClusterId, ServerId
io_size The amount of data processed by SSStore per second. byte ClusterId, ServerId
io_write_size The amount of data written to SSStore per second. byte ClusterId, ServerId
transaction_multi_partition_count The number of distributed transactions per second. times/s ClusterId, ServerId
transaction_partition_count The number of transactions per second. times/s ClusterId, ServerId
transaction_single_partition_count The number of ordinary transactions per second. times/s ClusterId, ServerId
trans_commit_log_sync_rt The average time consumed in synchronizing transaction logs over the network. μs ClusterId, ServerId
load1 The average load of the system over the last 1 minute. - ClusterId, ServerId
load15 The average load of the system over the last 15 minutes. - ClusterId, ServerId
load5 The average load of the system over the last 5 minutes. - ClusterId, ServerId
cpu_percent The CPU usage. Percentage (%) ClusterId, ServerId
memory_buffers The size of the kernel buffer cache. GiB ClusterId, ServerId
memory_cached The size of memory used for caching. GiB ClusterId, ServerId
memory_free The size of available physical memory. GiB ClusterId, ServerId
memory_used The size of physical memory used. GiB ClusterId, ServerId
io The average number of I/O operations performed per second. times/s ClusterId, ServerId
io_read The number of read operations performed per second. times/s ClusterId, ServerId
io_write The number of write operations performed per second. times/s ClusterId, ServerId
io_read_time The average time consumed in reading data. ms ClusterId, ServerId
io_time The I/O time. ms ClusterId, ServerId
io_write_time The average time consumed in writing data. ms ClusterId, ServerId
io_byte The average amount of data processed per second. MiB ClusterId, ServerId
io_read_byte The amount of data read each time. MiB ClusterId, ServerId
io_write_byte The amount of data written each time. MiB ClusterId, ServerId
net_recv The amount of data received per second. MiB ClusterId, ServerId
net_send The amount of data sent per second. MiB ClusterId, ServerId
net_throughput The network throughput. MiB ClusterId, ServerId
ntp_offset_milliseconds The NTP clock offset. ms ClusterId, ServerId
ob_data_disk_percent The usage of the OB data disk. Percentage (%) ClusterId, ServerId
ob_clog_disk_percent The usage of the OB log disk. Percentage (%) ClusterId, ServerId
ob_data_disk_used_size The size of the OB data disk. GiB ClusterId, ServerId
ob_process_exists The status of the OB process. - ClusterId, ServerId
ob_waitevent_count Number of wait events. - ClusterId, ServerId
ob_sql_event Number of database execution events in a given state. - ClusterId, ServerId
ob_worktime Database work time. ms ClusterId, ServerId
ob_no_idle_waiting_time Database non-idle wait time. ms ClusterId, ServerId
ob_tenant_log_disk_total_bytes Total log disk capacity. GiB ClusterId, ServerId
ob_tenant_log_disk_used_bytes Log disk space used. GiB ClusterId, ServerId
ob_tenant_server_required_size Space occupied by data. MiB ClusterId, ServerId
ob_tenant_server_data_size Data size. MiB ClusterId, ServerId
ob_tenant_binlog_disk_used Binlog disk space used. GiB ClusterId, ServerId
memory_percent Memory utilization. Percentage (%) ClusterId, ServerId
ob_data_required_size Space occupied by data. MiB ClusterId, ServerId
ob_clog_io Average number of I/O operations per second on the OB log disk. - ClusterId, ServerId
ob_clog_io_time Average I/O time per second on the OB log disk. μs ClusterId, ServerId
ob_clog_io_byte Average amount of I/O data per second on the OB log disk. MiB ClusterId, ServerId
ob_clog_io_util I/O busy percentage of the OB log disk. Percentage (%) ClusterId, ServerId
obcloud.metric_chart.host.log_disk_io_util_percent I/O utilization of the OB log disk. Percentage (%) ClusterId, ServerId
obcloud.metric_chart.host.log_disk_throughput_util_percent Throughput utilization of the OB log disk. Percentage (%) ClusterId, ServerId
ob_data_io Average number of I/O operations per second on the OB data disk. - ClusterId, ServerId
ob_data_io_time Average time per I/O operation on the OB data disk. ms ClusterId, ServerId
ob_data_io_byte Average amount of I/O data per second on the OB data disk. MiB ClusterId, ServerId
ob_data_io_util I/O busy percentage of the OB data disk. Percentage (%) ClusterId, ServerId
obcloud.metric_chart.host.data_disk_io_util_percent I/O utilization of the OB data disk. Percentage (%) ClusterId, ServerId
obcloud.metric_chart.host.data_disk_throughput_util_percent Throughput utilization of the OB data disk. Percentage (%) ClusterId, ServerId
ob_host_real_time_iops OB host IOPS. - ClusterId, ServerId
ob_host_real_time_throughput OB host throughput. MiB/s ClusterId, ServerId
ob_host_iops_used_percent OB host I/O utilization. Percentage (%) ClusterId, ServerId
ob_host_throughput_used_percent OB host throughput utilization. Percentage (%) ClusterId, ServerId
uptime Uptime. hours ClusterId, ServerId

Supported metrics for tenant monitoring

Metric Name
Description
Unit
Dimensions
sql_all_count The number of SQL statements processed per second. times/s ClusterId, TenantId, ServerId
sql_delete_count The number of Delete statements processed per second. times/s ClusterId, TenantId, ServerId
sql_insert_count The number of Insert statements processed per second. times/s ClusterId, TenantId, ServerId
sql_other_count The number of other statements such as DDL, DCL, and DTL statements processed per second. times/s ClusterId, TenantId, ServerId
sql_replace_count The number of Replace statements processed per second. times/s ClusterId, TenantId, ServerId
sql_select_count The number of Select statements processed per second. times/s ClusterId, TenantId, ServerId
sql_update_count The number of Update statements processed per second. times/s ClusterId, TenantId, ServerId
sql_all_rt The average processing time of SQL statements. ms ClusterId, TenantId, ServerId
sql_delete_rt The average processing time of Delete statements. ms ClusterId, TenantId, ServerId
sql_insert_rt The average processing time of Insert statements. ms ClusterId, TenantId, ServerId
sql_other_rt The average processing time of other statements such as DDL, DCL, and DTL statements. ms ClusterId, TenantId, ServerId
sql_replace_rt The average processing time of Replace statements. ms ClusterId, TenantId, ServerId
sql_select_rt The average processing time of Select statements. ms ClusterId, TenantId, ServerId
sql_update_rt The average processing time of Update statements. ms ClusterId, TenantId, ServerId
sql_all_rt_p99 99th-percentile average processing time of SQL statements. ms ClusterId, TenantId, ServerId
sql_delete_rt_p99 99th-percentile average processing time of DELETE statements. ms ClusterId, TenantId, ServerId
sql_insert_rt_p99 99th-percentile average processing time of INSERT statements. ms ClusterId, TenantId, ServerId
sql_other_rt_p99 99th-percentile average processing time of other SQL statements. ms ClusterId, TenantId, ServerId
sql_replace_rt_p99 99th-percentile average processing time of REPLACE statements. ms ClusterId, TenantId, ServerId
sql_select_rt_p99 99th-percentile average processing time of SELECT statements. ms ClusterId, TenantId, ServerId
sql_update_rt_p99 99th-percentile average processing time of UPDATE statements. ms ClusterId, TenantId, ServerId
sql_all_rt_p95 95th-percentile average processing time of SQL statements. ms ClusterId, TenantId, ServerId
sql_delete_rt_p95 95th-percentile average processing time of DELETE statements. ms ClusterId, TenantId, ServerId
sql_insert_rt_p95 95th-percentile average processing time of INSERT statements. ms ClusterId, TenantId, ServerId
sql_other_rt_p95 95th-percentile average processing time of other SQL statements. ms ClusterId, TenantId, ServerId
sql_replace_rt_p95 95th-percentile average processing time of REPLACE statements. ms ClusterId, TenantId, ServerId
sql_select_rt_p95 95th-percentile average processing time of SELECT statements. ms ClusterId, TenantId, ServerId
sql_update_rt_p95 95th-percentile average processing time of UPDATE statements. ms ClusterId, TenantId, ServerId
sql_all_rt_p90 90th-percentile average processing time of SQL statements. ms ClusterId, TenantId, ServerId
sql_delete_rt_p90 90th-percentile average processing time of DELETE statements. ms ClusterId, TenantId, ServerId
sql_insert_rt_p90 90th-percentile average processing time of INSERT statements. ms ClusterId, TenantId, ServerId
sql_other_rt_p90 90th-percentile average processing time of other SQL statements. ms ClusterId, TenantId, ServerId
sql_replace_rt_p90 90th-percentile average processing time of REPLACE statements. ms ClusterId, TenantId, ServerId
sql_select_rt_p90 90th-percentile average processing time of SELECT statements. ms ClusterId, TenantId, ServerId
sql_update_rt_p90 90th-percentile average processing time of UPDATE statements. ms ClusterId, TenantId, ServerId
active_session The number of active sessions. - ClusterId, TenantId, ServerId
all_session The number of sessions. - ClusterId, TenantId, ServerId
sql_distributed_count The number of distributed execution plans processed per second. times/s ClusterId, TenantId, ServerId
sql_local_count The number of local executions processed per second. times/s ClusterId, TenantId, ServerId
sql_remote_count The number of remote execution plans processed per second. times/s ClusterId, TenantId, ServerId
slow_sql_count Number of slow SQL statements. - ClusterId, TenantId, ServerId
ob_sql_event Number of database execution events in a given state. - ClusterId, TenantId, ServerId
ob_sql_event_in_parse Number of execution events in the parse state. - ClusterId, TenantId, ServerId
ob_sql_event_in_pl_parse Number of execution events in the pl parse state. - ClusterId, TenantId, ServerId
ob_sql_event_in_plan_cache Number of execution events in the plan cache state. - ClusterId, TenantId, ServerId
ob_sql_event_in_sql_optimize Number of execution events in the sql optimize state. - ClusterId, TenantId, ServerId
ob_sql_event_in_sql_execution Number of execution events in the sql execution state. - ClusterId, TenantId, ServerId
ob_sql_event_in_px_execution Number of execution events in the px execution state. - ClusterId, TenantId, ServerId
ob_sql_event_in_sequence_load Number of execution events in the sequence load state. - ClusterId, TenantId, ServerId
ob_sql_event_in_committing Number of execution events in the committing state. - ClusterId, TenantId, ServerId
ob_sql_event_in_storage_read Number of execution events in the storage read state. - ClusterId, TenantId, ServerId
ob_sql_event_in_storage_write Number of tenant execution events in the storage write state. - ClusterId, TenantId, ServerId
ob_sql_event_in_remote_das_execution Number of execution events in the remote das execution state. - ClusterId, TenantId, ServerId
ob_sql_event_in_plsql_compilation Number of execution events in the plsql compilation state. - ClusterId, TenantId, ServerId
ob_sql_event_in_plsql_execution Number of execution events in the plsql execution state. - ClusterId, TenantId, ServerId
system_event_internal_total_waits The number of internal wait events per second. times/s ClusterId, TenantId, ServerId
system_event_io_total_waits The number of I/O wait events per second. times/s ClusterId, TenantId, ServerId
system_event_latch_total_waits The number of latch wait events per second. times/s ClusterId, TenantId, ServerId
system_event_other_total_waits The number of other wait events per second. times/s ClusterId, TenantId, ServerId
system_event_row_lock_wait_total_waits The average lock wait time. ms ClusterId, TenantId, ServerId
system_event_sync_rpc_total_waits The average synchronous RPC wait time. ms ClusterId, TenantId, ServerId
wait_event_count The number of wait events per second. - ClusterId, TenantId, ServerId
system_event_other_count Number of other wait events. - ClusterId, TenantId, ServerId
system_event_application_count Number of application wait events. - ClusterId, TenantId, ServerId
system_event_configuration_count Number of configuration wait events. - ClusterId, TenantId, ServerId
system_event_administrative_count Number of administrative wait events. - ClusterId, TenantId, ServerId
system_event_concurrency_count Number of concurrency wait events. - ClusterId, TenantId, ServerId
system_event_commit_count Number of commit wait events. - ClusterId, TenantId, ServerId
system_event_idle_count Number of idle wait events. - ClusterId, TenantId, ServerId
system_event_network_count Number of network wait events. - ClusterId, TenantId, ServerId
system_event_user_io_count Number of user_io wait events. - ClusterId, TenantId, ServerId
system_event_system_io_count Number of system_io wait events. - ClusterId, TenantId, ServerId
system_event_scheduler_count Number of scheduler wait events. - ClusterId, TenantId, ServerId
system_event_cluster_count Number of cluster wait events. - ClusterId, TenantId, ServerId
wait_event_rt The average wait time. ms ClusterId, TenantId, ServerId
system_event_other_time_waites Average time spent on other_time wait events. ms ClusterId, TenantId, ServerId
system_event_application_time_waites Average time spent on application_time wait events. ms ClusterId, TenantId, ServerId
system_event_configuration_time_waites Average time spent on configuration_time wait events. ms ClusterId, TenantId, ServerId
system_event_administrative_time_waites Average time spent on administrative_time wait events. ms ClusterId, TenantId, ServerId
system_event_concurrency_waites Average time spent on concurrency wait events. ms ClusterId, TenantId, ServerId
system_event_commit_waites Average time spent on commit wait events. ms ClusterId, TenantId, ServerId
system_event_idle_waites Average time spent on idle wait events. ms ClusterId, TenantId, ServerId
system_event_network_waites Average time spent on network wait events. ms ClusterId, TenantId, ServerId
system_event_user_io_waites Average time spent on user_io wait events. ms ClusterId, TenantId, ServerId
system_event_system_io_waites Average time spent on system_io wait events. ms ClusterId, TenantId, ServerId
system_event_scheduler_waites Average time spent on scheduler wait events. ms ClusterId, TenantId, ServerId
system_event_cluster_waites Average time spent on cluster wait events. ms ClusterId, TenantId, ServerId
request_dequeue_count The number of requests dequeued from the processing queue per second. times/s ClusterId, TenantId, ServerId
request_enqueue_count The number of requests enqueued into the processing queue per second. times/s ClusterId, TenantId, ServerId
request_queue_time The average waiting time of SQL statements in the waiting queue. μs ClusterId, TenantId, ServerId
ob_waitevent_count Number of wait events. - ClusterId, TenantId, ServerId
ob_foreground_waitevent_count Number of foreground database wait events in a given state. - ClusterId, TenantId, ServerId
ob_background_waitevent_count Number of background database wait events in a given state. - ClusterId, TenantId, ServerId
ob_cpu_percent The CPU utilization. Percentage (%) ClusterId, TenantId, ServerId
ob_tenant_memory_percent OB tenant memory utilization. Percentage (%) ClusterId, TenantId, ServerId
memstore_percent The percentage of MEMStore usage. Percentage (%) ClusterId, TenantId, ServerId
opened_cursors_count The number of open cursors. - ClusterId, TenantId, ServerId
rpc_packet_in_rt The average time taken to receive an RPC packet. μs ClusterId, TenantId, ServerId
rpc_packet_out_rt The average time taken to send an RPC packet. μs ClusterId, TenantId, ServerId
rpc_packet_in The throughput of receiving RPC packets. byte ClusterId, TenantId, ServerId
rpc_packet_out The throughput of sending RPC packets. byte ClusterId, TenantId, ServerId
ob_worktime Database work time. ms ClusterId, TenantId, ServerId
ob_foreground_worktime Foreground database work time. ms ClusterId, TenantId, ServerId
ob_background_worktime Background database work time. ms ClusterId, TenantId, ServerId
ob_no_idle_waiting_time Database non-idle wait time. s ClusterId, TenantId, ServerId
ob_foreground_no_idle_waiting_time Foreground database non-idle wait time. s ClusterId, TenantId, ServerId
ob_background_no_idle_waiting_time Background database non-idle wait time. s ClusterId, TenantId, ServerId
ob_clog_ls_max_replayed_scn Replica lag. ms ClusterId, TenantId, ServerId
transaction_commit_count The number of transactions committed per second. times/s ClusterId, TenantId, ServerId
transaction_count The number of transactions processed per second. times/s ClusterId, TenantId, ServerId
transaction_rollback_count The number of transactions rolled back per second. times/s ClusterId, TenantId, ServerId
transaction_timeout_count The number of transactions that time out per second. times/s ClusterId, TenantId, ServerId
transaction_commit_rt The average transaction commit time. ms ClusterId, TenantId, ServerId
transaction_rollback_rt The average transaction rollback time. ms ClusterId, TenantId, ServerId
transaction_rt The average transaction processing time ms ClusterId, TenantId, ServerId
trans_commit_log_count The number of transaction logs committed per second times/s ClusterId, TenantId, ServerId
clog_trans_log_total_size The size of transaction logs committed per second byte ClusterId, TenantId, ServerId
memstore_write_lock_fail_count The number of write lock wait failures per second times/s ClusterId, TenantId, ServerId
memstore_write_lock_succ_count The number of write lock wait successes per second times/s ClusterId, TenantId, ServerId
memstore_write_lock_wait_time The average write lock wait time μs ClusterId, TenantId, ServerId
transaction_multi_partition_count The number of distributed transactions per second times/s ClusterId, TenantId, ServerId
transaction_single_partition_count The number of normal transactions per second times/s ClusterId, TenantId, ServerId
trans_commit_log_sync_rt The average time for each transaction log network synchronization μs ClusterId, TenantId, ServerId
active_memstore_used The size of the active MEMStore MiB ClusterId, TenantId, ServerId
major_freeze_trigger The major freeze trigger threshold MiB ClusterId, TenantId, ServerId
memstore_limit The limit of the MEMStore MiB ClusterId, TenantId, ServerId
total_memstore_used The total size of the MEMStore MiB ClusterId, TenantId, ServerId
io_read_count The number of SSStore reads per second times/s ClusterId, TenantId, ServerId
io_write_count The number of SSStore writes per second times/s ClusterId, TenantId, ServerId
io_read_rt The average read time for each SSStore read μs ClusterId, TenantId, ServerId
io_write_rt The average write time for each SSStore write μs ClusterId, TenantId, ServerId
io_read_size The size of data read from the SSStore per second byte ClusterId, TenantId, ServerId
io_write_size The size of data written to the SSStore per second byte ClusterId, TenantId, ServerId
io_function_local_other_groups_schedule_us Local disk I/O scheduling time for other tasks. μs ClusterId, TenantId, ServerId
io_function_local_compaction_high_schedule_us Local disk I/O scheduling time for high-priority compaction tasks. μs ClusterId, TenantId, ServerId
io_function_local_ha_high_schedule_us Local disk I/O scheduling time for high-priority high-reliability tasks. μs ClusterId, TenantId, ServerId
io_function_local_compaction_mid_schedule_us Local disk I/O scheduling time for medium-priority compaction tasks. μs ClusterId, TenantId, ServerId
io_function_local_ha_mid_schedule_us Local disk I/O scheduling time for medium-priority high-reliability tasks. μs ClusterId, TenantId, ServerId
io_function_local_compaction_low_schedule_us Local disk I/O scheduling time for low-priority compaction tasks. μs ClusterId, TenantId, ServerId
io_function_local_ha_low_schedule_us Local disk I/O scheduling time for low-priority high-reliability tasks. μs ClusterId, TenantId, ServerId
io_function_local_ddl_schedule_us Local disk I/O scheduling time for regular DDL tasks. μs ClusterId, TenantId, ServerId
io_function_local_ddl_high_schedule_us Local disk I/O scheduling time for high-priority DDL tasks. μs ClusterId, TenantId, ServerId
io_function_local_clog_low_schedule_us Local disk I/O scheduling time for low-priority log tasks. μs ClusterId, TenantId, ServerId
io_function_local_clog_mid_schedule_us Local disk I/O scheduling time for medium-priority log tasks. μs ClusterId, TenantId, ServerId
io_function_local_clog_high_schedule_us Local disk I/O scheduling time for high-priority log tasks. μs ClusterId, TenantId, ServerId
io_function_local_opt_stats_schedule_us Local disk I/O scheduling time for statistics collection tasks. μs ClusterId, TenantId, ServerId
io_function_local_import_schedule_us Local disk I/O scheduling time for data import tasks. μs ClusterId, TenantId, ServerId
io_function_local_export_schedule_us Local disk I/O scheduling time for data export tasks. μs ClusterId, TenantId, ServerId
io_function_local_gc_macro_block_schedule_us Local disk I/O scheduling time for macroblock reclamation and reuse tasks. μs ClusterId, TenantId, ServerId
io_function_local_sql_audit_schedule_us Local disk I/O scheduling time for SQL audit log flushing tasks. μs ClusterId, TenantId, ServerId
io_function_local_micro_mini_merge_schedule_us Local disk I/O scheduling time for microblock MiniMerge tasks. μs ClusterId, TenantId, ServerId
io_function_local_other_groups_delay_us Local disk I/O latency for other tasks. ms ClusterId, TenantId, ServerId
io_function_local_compaction_high_delay_us Local disk I/O latency for high-priority compaction tasks. ms ClusterId, TenantId, ServerId
io_function_local_ha_high_delay_us Local disk I/O latency for high-priority high-reliability tasks. ms ClusterId, TenantId, ServerId
io_function_local_compaction_mid_delay_us Local disk I/O latency for medium-priority compaction tasks. ms ClusterId, TenantId, ServerId
io_function_local_ha_mid_delay_us Local disk I/O latency for medium-priority high-reliability tasks. ms ClusterId, TenantId, ServerId
io_function_local_compaction_low_delay_us Local disk I/O latency for low-priority compaction tasks. ms ClusterId, TenantId, ServerId
io_function_local_ha_low_delay_us Local disk I/O latency for low-priority high-reliability tasks. ms ClusterId, TenantId, ServerId
io_function_local_ddl_delay_us Local disk I/O latency for regular DDL tasks. ms ClusterId, TenantId, ServerId
io_function_local_ddl_high_delay_us Local disk I/O latency for high-priority DDL tasks. ms ClusterId, TenantId, ServerId
io_function_local_clog_low_delay_us Local disk I/O latency for low-priority log tasks. ms ClusterId, TenantId, ServerId
io_function_local_clog_mid_delay_us Local disk I/O latency for medium-priority log tasks. ms ClusterId, TenantId, ServerId
io_function_local_clog_high_delay_us Local disk I/O latency for high-priority log tasks. ms ClusterId, TenantId, ServerId
io_function_local_opt_stats_delay_us Local disk I/O latency for statistics collection tasks. ms ClusterId, TenantId, ServerId
io_function_local_import_delay_us Local disk I/O latency for data import tasks. ms ClusterId, TenantId, ServerId
io_function_local_export_delay_us Local disk I/O latency for data export tasks. ms ClusterId, TenantId, ServerId
io_function_local_gc_macro_block_delay_us Local disk I/O latency for macroblock reclamation and reuse tasks. ms ClusterId, TenantId, ServerId
io_function_local_sql_audit_delay_us Local disk I/O latency for SQL audit log flushing tasks. ms ClusterId, TenantId, ServerId
io_function_local_micro_mini_merge_delay_us Local disk I/O latency for microblock MiniMerge tasks. ms ClusterId, TenantId, ServerId
io_function_local_other_groups_total_us Total local disk I/O time for other tasks. ms ClusterId, TenantId, ServerId
io_function_local_compaction_high_total_us Total local disk I/O time for high-priority compaction tasks. ms ClusterId, TenantId, ServerId
io_function_local_ha_high_total_us Total local disk I/O time for high-priority high-reliability tasks. ms ClusterId, TenantId, ServerId
io_function_local_compaction_mid_total_us Total local disk I/O time for medium-priority compaction tasks. ms ClusterId, TenantId, ServerId
io_function_local_ha_mid_total_us Total local disk I/O time for medium-priority high-reliability tasks. ms ClusterId, TenantId, ServerId
io_function_local_compaction_low_total_us Total local disk I/O time for low-priority compaction tasks. ms ClusterId, TenantId, ServerId
io_function_local_ha_low_total_us Total local disk I/O time for low-priority high-reliability tasks. ms ClusterId, TenantId, ServerId
io_function_local_ddl_total_us Total local disk I/O time for regular DDL tasks. ms ClusterId, TenantId, ServerId
io_function_local_ddl_high_total_us Total local disk I/O time for high-priority DDL tasks. ms ClusterId, TenantId, ServerId
io_function_local_clog_low_total_us Total local disk I/O time for low-priority log tasks. ms ClusterId, TenantId, ServerId
io_function_local_clog_mid_total_us Total local disk I/O time for medium-priority log tasks. ms ClusterId, TenantId, ServerId
io_function_local_clog_high_total_us Total local disk I/O time for high-priority log tasks. ms ClusterId, TenantId, ServerId
io_function_local_opt_stats_total_us Total local disk I/O time for statistics collection tasks. ms ClusterId, TenantId, ServerId
io_function_local_import_total_us Total local disk I/O time for data import tasks. ms ClusterId, TenantId, ServerId
io_function_local_export_total_us Total local disk I/O time for data export tasks. ms ClusterId, TenantId, ServerId
io_function_local_gc_macro_block_total_us Total local disk I/O time for macroblock reclamation and reuse tasks. ms ClusterId, TenantId, ServerId
io_function_local_sql_audit_total_us Total local disk I/O time for SQL audit log flushing tasks. ms ClusterId, TenantId, ServerId
io_function_local_micro_mini_merge_total_us Total local disk I/O time for microblock MiniMerge tasks. ms ClusterId, TenantId, ServerId
io_group_write_net_bandwidth Group OSS write I/O bandwidth. Byte ClusterId, TenantId, ServerId
io_group_read_net_bandwidth Group OSS read I/O bandwidth. Byte ClusterId, TenantId, ServerId
ob_tenant_log_disk_total_bytes Total log disk capacity. GiB ClusterId, TenantId, ServerId
ob_tenant_log_disk_used_bytes Log disk space used. MiB ClusterId, TenantId, ServerId
ob_tenant_server_required_size Space occupied by data. MiB ClusterId, TenantId, ServerId
ob_tenant_server_data_size Data size. MiB ClusterId, TenantId, ServerId
obcloud.metric_chart.ob.ob_tenant_vector_mem_hold_size Memory occupied by tenant vector index data. GiB ClusterId, TenantId, ServerId
obcloud.metric_chart.ob.ob_tenant_vector_mem_used_size Memory actually used by tenant vector index data. GiB ClusterId, TenantId, ServerId
obcloud.metric_chart.ob.ob_tenant_vector_mem_limit_size Memory usage limit for tenant vector index data. GiB ClusterId, TenantId, ServerId
obcloud.metric_chart.ob.ob_tenant_vector_mem_used_percent Vector index data usage percentage. Percentage (%) ClusterId, TenantId, ServerId
block_cache_size Block cache size. MiB ClusterId, TenantId, ServerId
bloom_filter_cache_size The size of the bloom filter cache MiB ClusterId, TenantId, ServerId
clog_cache_size The size of the Clog cache MiB ClusterId, TenantId, ServerId
location_cache_size The size of the location cache MiB ClusterId, TenantId, ServerId
plan_cache_size The size of the execution plan cache MiB ClusterId, TenantId, ServerId
row_cache_size The size of the row cache MiB ClusterId, TenantId, ServerId
block_cache_hit_ratio The block cache hit rate Percentage (%) ClusterId, TenantId, ServerId
bloom_filter_cache_hit_ratio The bloom filter cache hit rate Percentage (%) ClusterId, TenantId, ServerId
clog_cache_hit_ratio The Clog cache hit rate Percentage (%) ClusterId, TenantId, ServerId
location_cache_hit_ratio The location cache hit rate Percentage (%) ClusterId, TenantId, ServerId
plan_cache_hit_ratio The execution plan cache hit rate Percentage (%) ClusterId, TenantId, ServerId
row_cache_hit_ratio The row cache hit rate Percentage (%) ClusterId, TenantId, ServerId
block_cache_req_total The number of block cache requests per second times/s ClusterId, TenantId, ServerId
bloom_filter_cache_req_total The number of bloom filter cache requests per second times/s ClusterId, TenantId, ServerId
clog_cache_req_total The number of Clog cache requests per second times/s ClusterId, TenantId, ServerId
location_cache_req_total The number of location cache requests per second times/s ClusterId, TenantId, ServerId
row_cache_req_total The number of row cache requests per second times/s ClusterId, TenantId, ServerId
ob_tenant_binlog_disk_used The size of the binlog disk used GiB ClusterId, TenantId, ServerId
binlog_instance_convert_delay Binlog conversion latency. ms ClusterId, TenantId, ServerId
binlog_instance_convert_iops Binlog conversion IOPS. MiB ClusterId, TenantId, ServerId
binlog_instance_convert_storage_rps Binlog conversion RPS. - ClusterId, TenantId, ServerId
binlog_instance_dump_delay Binlog transmission latency. s ClusterId, TenantId, ServerId
binlog_instance_dump_iops Binlog network traffic. MiB ClusterId, TenantId, ServerId
binlog_instance_dump_rps Binlog transmission RPS. - ClusterId, TenantId, ServerId

Previous topic

DescribeTenantMetrics
Last

Next topic

CreatePrometheusIntegration - Create a Prometheus Monitoring Integration
Next
on this page
Overview
API details
Constraints
Request path
Request parameters
Body
Response parameters
Examples
Request example
Response example
List of cluster monitoring metrics
Supported metrics for tenant monitoring