OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Cloud Platform

V4.3.6

  • What's New
    • Product Updates
  • Product Introduction
    • What is OceanBase Cloud Platform
    • Differences between Enterprise Edition and Community Edition
    • System architecture
    • Features
    • Limits
      • System requirements
      • Dependencies
  • Deploy OceanBase Cloud Platform (OCP)
    • Deploy OceanBase Cloud Platform (OCP) Community Edition
      • Installation process
      • Prepare for the installation
      • Overview
      • Post-deployment check
      • Use Docker to deploy OCP
      • Deploy OCP on the GUI
      • Installation planning
        • User planning
        • Host planning
        • Disk and directory planning
        • Port planning
      • Appendix
        • Install Docker
        • Restart OCP
        • FAQ about deployment
        • Uninstall OCP
    • Deploy OceanBase Cloud Platform (OCP) Enterprise Edition
      • Deployment overview
        • Deploy OCP cluster in the High-availability
        • Deploy OCP cluster in the Single-node
      • Prepare the deployment environment
        • Install OAT
        • Add a server
        • Check the environment
      • Deploy OCP
        • Plan resources
          • Planning resources of a single node OCP
            • MonitorDB resources
            • OCP-Server specifications
            • Host resources
            • MetaDB resources
          • Planning resources of a high availability OCP
            • MonitorDB resources
            • Host resources
            • MetaDB resources
            • OCP-Server specifications
        • Deploy OCP
          • Deploying a single point of OCP
            • Prepare installation media
            • Create MetaDB
            • Install OCP
            • Initialize system parameters
          • Deploying a high availability of OCP
            • Create MetaDB
            • Initialize system parameters
            • Register an OCP cluster
            • Prepare installation media
            • Install OCP
        • Check after deployment
      • Deployment FAQ
        • Optimize MonitorDB parameters
        • F5 Big-IP LTM and alert configuration
          • Monitor the OCP service health
          • Connect OBProxy to F5 Big-IP LTM
          • Connect OCP-Console to F5 Big-IP LTM
        • Ubuntu deployment FAQ
        • EulerOS deployment FAQ
        • Client requirements
        • Start and stop OCP
      • Appendix
        • Uninstall OCP
        • Check the NTP offset
  • Upgrade OceanBase Cloud Platform (OCP)
    • Upgrade OceanBase Cloud Platform (OCP) Enterprise Edition
      • Overview
      • Considerations
      • Preparations
      • Upgrade OCP
        • Take over OCP
        • Upgrade OCP
      • Verify after upgrade
        • Verify the cluster feature
        • Verify the tenant feature
        • Verify the host feature
        • Verify the software package feature
        • Verify the OBProxy feature
        • Verify the backup and restore feature
        • Verify alerts
        • Verify the task feature
        • Verify the password box feature
      • Appendix
        • Version mapping
        • Change a user's password
    • Upgrade OceanBase Cloud Platform (OCP) Community Edition
      • Post-upgrade check
      • Upgrade OCP on the GUI
      • Upgrade OCP using Docker containers
  • Quick Start
    • OCP operations
    • Log on to the OCP console
    • Upload a software package
    • Add hosts
    • Create a cluster
    • Create a primary tenant
    • Create a user
    • Create an OBProxy cluster
  • Cluster Management
    • Upgrade version
    • View the topology of a cluster
    • Overview of cluster tenant management
    • Overview
    • Manage cluster parameter templates
    • Manage clusters
      • Create a standby cluster
      • View details of a cluster
      • Scale a standalone system to a distributed cluster
      • Take over a cluster
      • Restart a cluster
      • Stop a cluster
      • Move out a cluster
      • Delete a cluster
      • Change the password
      • Manage Arbitration Service of a cluster
        • Add an arbitration service group
        • Remove an arbitration service
        • Add an arbitration service
        • Replace the arbitration service for a cluster
      • Enable automatic detection of deadlocks
      • Disable automatic detection of deadlocks
      • Manage O&M configuration
        • Manage parameters
        • Configure resources for OCP Agent
        • Overview
        • View the parameter modification history
      • Manage CPU binding configurations
      • Import a license
      • View the license
    • Manage Service Groups
      • Edit an arbitration service group
      • Create an arbitration service group
      • Delete an arbitration service group
      • Overview
      • Upgrade an arbitration service group
    • Manage OBServers of a cluster
      • Add an OBServer node
      • Restart a faulty OBServer node
      • Stop an OBServer service
      • Stop an observer process
      • Replace an OBServer node
      • Reinstall an OBServer
      • Delete an OBServer
    • Manage zones of a cluster
      • Add a zone
      • Edit a zone
      • Restart a zone
      • Stop a zone
      • Delete a zone
    • Manage Arbitration Services
      • Arbitration service Overview
      • Create an arbitration service
      • Take over an arbitration service
      • Stop an arbitration service
      • Start an arbitration service
      • Upgrade an arbitration service
      • Restart an arbitration service
      • Migrate an arbitration service
      • Replace an arbitration service
      • Associate a cluster
      • Dissociate an arbitration service
      • Delete an arbitration service
    • Manage cluster resource
      • View the unit distribution
      • View resource usage
    • Manage cluster parameters
      • Parameter types
      • View parameters
      • Modify parameters
      • View the history of parameter changes
    • Manage major compaction of a cluster
      • Modify the major compaction settings of a cluster
      • Perform a major compaction
      • View details of a major compaction
      • View statistics of a major compaction
      • View the major compaction records
    • Create a cluster
      • Create a distributed cluster
      • Create a standalone deployment
    • Manage security configurations
      • Manage Transparent Data Encryption (TDE)
  • Tenant Management
    • Tenant and resource management
    • Create a primary tenant
    • Manage tenant parameter templates
    • View OCP resource unit specifications
    • Manage unit specifications
    • Manage databases
    • Manage the resources of a tenant
    • View tenant overview information
    • Manage tenants
      • Overview
      • Create a standby tenant
      • Copy a tenant
      • Rename a tenant
      • Lock a tenant
      • Clone a tenant
      • Delete a tenant
      • Change the password of the sys tenant
      • Configure full link tracking for a tenant
      • Modify the allowlist of a tenant
      • Modify the zone priority
      • Manage the binlog service for a tenant
      • Manage service names
    • Manage major compaction under a tenant
      • Perform a major compaction
      • Modify major compaction settings of a tenant
      • View details of tenant major compaction
      • View the major compaction records
    • Manage resource isolation
      • Overview
      • Create a resource group
      • Create a resource isolation plan
      • Enable or disable a resource isolation plan
      • Modify a resource isolation plan
      • Delete a resource isolation plan
      • Modify a resource group
      • Delete a resource group
    • Manage users and permissions under a tenant
      • System permissions
      • Manage users in a MySQL tenant
      • Manage user under an Oracle tenant
        • Create a role under an Oracle tenant
        • Create a user under an Oracle tenant
        • Delete a user under an Oracle tenant
        • User overview under an Oracle tenant
        • Manage roles
        • Manage users
        • Change the password of a user under an Oracle tenant
    • Manage statistical information
      • Collect statistics
      • Manage statistics collection tasks
      • Overview
    • Manage tenant parameters
      • View the parameters
      • Modify a parameter
      • View the parameter modification history
    • Manage replicas of a tenant
      • Edit tenant replicas in a zone
      • Add a replica
      • Delete a tenant replica from a zone
    • Manage topulogy of a tenant
      • View tenant topology
      • View the topology of the primary/standby relationships of a tenant
  • OBProxy Management
    • Manage OBProxy cluster parameters
    • Create an OBProxy cluster
    • View details on the OBProxy page
    • Request analysis
    • OBProxy parameters descpription
    • Client configuration
    • Manage OBProxy parameter templates
    • OBProxy management overview
    • Manage OBProxy Clusters
      • View details on the Overview page of an OBProxy cluster
      • Add a connectable OceanBase cluster
      • Manage load balancing
      • Change the password of the proxysys user
      • Change the password of the proxyro user
      • Move out an OBProxy cluster
      • Delete an OBProxy cluster
      • Upgrade an OBProxy cluster
      • Manage CPU core binding configurations
      • Stop or start an ODP cluster
      • Restart an ODP cluster
      • Delete a connected OceanBase cluster
      • Manage the proxyro account
    • Manage OBProxy Servers
      • Stop or start an OBProxy
      • Take over OBProxy
      • Refresh OBProxy configurations
      • Upgrade an OBProxy
      • Delete an OBProxy
      • Remove an OBProxy
      • Launch an OBProxy
      • Add an OBProxy
      • Restart an OBProxy
  • Binlog Service Management
    • Overview of Binlog service
    • Create a binlog cluster
    • Manage binlog parameter templates
    • Manage Binlog Instance
      • View a binlog instance
      • Configure throttling
      • Start and stop a binlog instance
      • Restart a binlog instance
      • Manage binlog instance parameters
    • Manage Binlog Server
      • Add a binlog node
      • Start and stop a binlog server
      • Delete a binlog server
      • Clear binlog instances on a host
    • Manage Binlog Clusters
      • Start and stop a binlog cluster
      • View information about a binlog cluster
      • Upgrade a binlog cluster
      • Restart a binlog cluster
      • Manage binlog cluster parameters
      • Delete a binlog cluster
  • Host Management
    • Manage hosts
      • Host management operations
      • View host details
      • Add a host
      • View the details of tasks on a host
      • Modify a host
      • Restart OCP-Agent
      • Reinstall OCP Agent
      • Remove a host
      • Check host standardization
      • Host standardization check items
      • OCP-Agent processes
      • OCP-Agent O&M Script Instructions
  • Alert Management
    • Overview
    • Alert-related concepts
    • Manage alert rules
      • Create an alert rule
      • Copy an alert rule
      • View an alert rule
      • Edit an alert rule
      • Export alert rule configurations
      • Alert rule groups
      • Delete an alert rule
    • Manage alert templates
      • Create an alert template
      • Set alert objects
      • Export alert templates
      • View an alert template
      • Copy an alert template
      • Edit an alert template
      • Delete an alert template
    • Manage alert channels
      • Create an alert channel
      • View an alert channel
      • Edit an alert channel
      • Copy an alert channel
      • Delete an alert channel
      • Examples of alert channel configuration
      • Examples of alert channel configuration
    • Manage alert push
      • Create an alert push
      • View an alert push
      • Edit an alert push
      • Delete an alert push
    • View alert events
    • Manage blocking conditions
      • Edit an alert blocking condition
      • Create a blocking condition
      • Delete an alert blocking condition
    • OCP alert template tag
    • Optional monitoring metrics for custom alerts
  • Dashboard Management
    • Manage dashboards
    • Monitoring dashboard overview
    • Manage groups
    • Manage charts
  • Performance Monitoring
    • Use the custom monitoring feature
      • View collection items
      • Overview
      • OCP metrics
      • Manage indicator items
        • Create a metric
        • Manage metrics
      • Manage charts
        • Create a chart
        • Manage charts
    • Manage monitoring
      • Overview
      • View database performance
      • View host performance monitoring data
      • View OBServer node performance monitoring data
      • View performance and SQL monitoring data
      • View transaction performance monitoring data
      • View storage and cache monitoring data
      • View database object monitoring data
      • View OBKV-Table monitoring data
      • View OBKV-HBase monitoring data
      • View OBKV-Redis monitoring data
      • View subscription connection monitoring charts
      • View performance monitoring data of a binlog instance
      • View resource monitoring data of a binlog instance
      • View host resource monitoring data
      • View host process monitoring data
      • View service monitoring data
      • View system monitoring data
      • View performance monitoring
      • Drill-down monitoring
      • Integrate monitoring data to an external time-series system
  • Diagnostics and Tuning
    • SQL Diagnostics
      • SQL Diagnostics Introduction
        • SQL diagnostics overview
        • SQL statement execution statistics
        • SQL execution plans
      • View the OceanBase Autonomy Service page
      • Diagnose suspicious SQL statements
      • Diagnose top SQL statements
      • View Comparison of Top SQL Statements
      • Diagnose slow SQL statements
      • Diagnose parallel SQL statements
      • Diagnose high-risk SQL statements
      • Diagnose new SQL statements
      • View the details of an SQL statement
      • View outlines
      • View the SQL collection enabling/disabling history
      • View SQL request analysis data
      • Parameters related to SQL performance diagnostics
    • Transaction Diagnostics
      • Diagnose transactions
      • Transaction overview
      • Diagnose XA transactions and suspended transactions
    • Manage sessions
      • Manage the sessions of a tenant
      • View session statistics
      • View row lock analytics
      • View the deadlock history
    • View the Optimization Center page
    • View the capacity center
    • View diagnostics reports
      • Manage performance reports
      • Manage ASH reports
  • O&M Management
    • Manage Information Collection
      • Download an information collection report
      • Configure information collection items
      • View information collection details
      • Overview
      • Create an information collection task
    • Manage Plans
      • Manage plans
      • Overview
      • View plan execution details
    • Manage Inspection
      • Overview
      • Configure inspection items
      • Configure Scheduling Rules
        • Configure a scheduling rule for a single inspection object
        • Configure global scheduling rules
      • Initiate Inspection
        • Initiate an inspection for a single object
        • Initiate a global inspection
      • View an inspection task
      • Manage Inspection reports
        • View an inspection report
        • Download an inspection report
    • Manage the report center
  • AI Assistant
    • Manage an AI intelligent conversation
    • Enable AI-powered intelligent conversation
    • Overview
  • Backup and Recovery
    • Copy a restore task
    • Overview
    • Backup and restore guide
    • Initiate a restore task
    • Overview
    • View restore task information
    • Manage backup tasks
      • View second backup tasks
      • View backup tasks
    • Manage backup and recovery service
      • View services
      • Install a service
      • Add a node
      • Upgrade the version of a service
      • Update service configurations
      • Copy a service
      • Delete a service
      • Stop a service on a node
      • Restart a service on a node
      • View O\&M tasks
      • Uninstall a service on a node
    • Regular backup
      • Manage cluster-level backup strategy
        • Create a cluster-level backup strategy
        • Modify a cluster-level backup strategy
        • Delete a cluster-level backup strategy
        • Pause backup scheduling
        • View a cluster-level backup stategy
      • Manage tenant-level backup strategy
        • Create a tenant-level backup strategy
        • Modify a tenant-level backup strategy
        • Delete a tenant-level backup strategy
        • Pause backup scheduling
        • View a tenant-level backup stategy
    • Regular recovery
      • View sampling strategies
      • View sampling tasks
      • Create a sampling strategy for recovery
    • Backup now
      • Perform tenant backup immediately
      • Back up a cluster now
  • Disaster Recovery
    • Switching primary and standby databases
      • Start the original primary cluster in read-only mode after a failover
      • Decouple a standby cluster from the primary cluster
      • Primary/Standby cluster switchover for disaster recovery
      • Routine primary/standby cluster switchover
    • Switching primary and standby tenants
      • Switchover
      • Failover
      • Decouple a standby tenant from its primary tenant
      • Create primary and standby tenants across OCP clusters
    • OCP Manage OCP clusters in the multi-cluster mode
      • OCP multi-cluster mode overview
      • Register an OCP cluster
      • View Leader \& Follower Details
      • Manage OCP cluster parameters
      • Switch an OCP cluster in daily maintenance
      • Switch an OCP cluster in a failover
      • Delete a faulty follower OCP cluster
      • Unbind a leader and a follower OCP cluster
      • Enable the OCP multi-cluster mode
  • Log Management
    • Download logs
    • Configure log retention strategies
    • Trace query
    • Query logs
    • Configure trace query parameters
    • About OpenSearch
  • Software Package Management
    • Delete a software package
    • Download a software package
    • Upload a software package
  • System Management
    • Manage password box
      • Create a credential
      • Export a credential
      • Import a credential
      • Verify a credential
      • Edit a credential
      • Delete a credential
      • Batch operations on credentials
    • Manage users and permissions
      • Overview
      • Manage a organization
        • View the resources of an organization
        • Delete an organization
        • Create an organization
        • Share resource configurations
        • Rename an organization
      • Manage a user
        • Copy a user
        • View a user
        • Delete a user
        • Change the password of a user
        • Edit a user
        • View the login history
        • Create a user
      • Manage a role
        • Create a role
        • View a role
        • Edit a role
        • Copy a role
        • Delete a role
        • Default OCP roles
    • Manage tags
      • Overview
      • Create a tag
      • Modify objects bound to a tag
      • Edit a tag
      • Delete a tag
    • View operation records
    • Manage external integration
      • Overview
      • Create an SSO integration task
      • Enable/Disable an SSO integration task
      • Edit an SSO integration task
      • Delete an SSO integration task
      • Manage AI models
        • Connect to an AI model vendor
        • Add a model
        • Set a system model
        • Delete a model
    • Manage system parameters
      • View system parameters
      • Modify system parameters
      • OCP configuration parameters
    • Manage tasks
    • User center management
      • Log off the OCP console
      • Configure personal information
      • Change your logon password
  • SQL Tuning Practices
    • Locate General Abnormal SQL Statements
      • How can I locate SQL statements for full-table scans in a tenant?
      • How can I locate SQL statements with high CPU load in a tenant?
      • How can I locate slow hard-parsed SQL statements in a tenant?
      • How can I locate erroneous SQL statements in a tenant?
      • How can I locate distributed SQL statements in a tenant?
      • How can I locate slow SQL statements that take a long time in a tenant?
      • How can I locate remote SQL statements in a tenant?
    • Customize Abnormal SQL Statement Determining Rules
      • Conditions
      • Custom column rules
    • General SQL Performance Tuning Scenarios
      • Execution Plan Optimization
        • SQL statement performance deterioration caused by plan changes
      • Index Optimization
        • No suitable indexes
        • Inappropriate index of an SQL statement
        • Invalid index of an SQL statement
  • O&M Best practices
    • Send alert messages through email
    • Check the availability of an auto-increment column
    • Decouple a standby tenant from the primary tenant
    • Perform a failover
    • Check clog synchronization
    • Send alert messages to a Feishu group
    • Integrate OCP monitoring with Prometheus
    • Troubleshoot host issues in an OceanBase cluster
    • Push alert messages through HTTP
    • Automatic routing to the new primary tenant after a switchover
    • Perform an inspection in OCP to detect potential risks in an OceanBase cluster
    • Take over OBProxies
    • Use the arbitration service of OceanBase Database to achieve HA in a scenario with two IDCs
    • Configure custom monitoring
    • Migrate a cluster between IDCs in OCP
    • Restore lost data by using backup and restore
    • Import a monitoring dashboard to Grafana
    • Monitor the business load of OceanBase Database
    • Upgrade an OceanBase cluster
    • Perform a failover between primary and standby OceanBase clusters for disaster recovery in a scenario with two IDCs
    • Replace an OBProxy
    • Reduce the high availability of OceanBase clusters and tenants
    • Scale out an OceanBase cluster and scale up an OceanBase Database tenant
    • Check the NIC rate
    • Migrate an OceanBase cluster to another IDC
    • Organization and permission management
    • Perform a switchover between primary and standby OceanBase Database tenants in a scenario with two IDCs
    • Delete an OBProxy
    • Scale in an OceanBase cluster and scale down an OceanBase Database tenant
    • Scale in an OBProxy cluster
    • Expand the high availability of OceanBase clusters and tenants
    • Scale out an OBProxy cluster
    • Send alert messages to a WeChat Enterprise group
    • Move out an OBProxy cluster
    • Back up an OceanBase cluster
    • Migrate a resource unit from an OceanBase Database tenant
    • Send alert messages to a DingTalk group
  • Reference Guide
    • Alarm reference
      • Overview
      • Application alerts
        • ob_host_ssd_wear_indicator_over_threshold
        • ob_host_net_recv_percent_over_threshold Host network receive bandwidth usage exceeds threshold
        • ob_host_tcp_retrans_percent_over_threshold The percentage of TCP retransmissions exceeding the threshold on the server
        • base_backup_too_long_time_no_one_success_task
        • backup_process_dead
        • backup_storage_capacity_over_threshold
        • backup_storage_capacity_timeout_or_interrupted Backup restore directory capacity retrieval timeout or thread interrupted
        • ocp_remote_server_time_diff_too_large
        • host_ntp_service_not_exist The NTP service does not exist on the server.
        • host_agent_goroutine_count_over_threshold The number of goroutines for the server agent exceeds the threshold.
        • partition_create_failed
        • host_disk_readonly
        • ic_server_connect_failed Inter-Connector server connection failed
        • vpc_connect_failed VPC connection failed
        • odp_sql_query_slow
        • agentd_process_stop
        • upgrade_ocp_agent_failed
        • host_agent_version_not_same
        • ocp_collect_metric_failure_rate_high OCP-Server collects metrics with a high failure rate
        • ocp_alarm_detect_timeout
        • ob_host_cpu_percent_over_threshold CPU usage on the server exceeds the threshold
        • ocp_meta_db_disconnected OCP Meta Database Disconnected
        • system_obproxy_unavailable
        • node_load1_peak
        • base_secondary_backup_fail
        • backup_storage_capacity_retry_times_exceeded The maximum number of retries to obtain backup storage capacity has been exceeded.
        • odp_instance_expanse_failed
        • inc_backup_delay
        • ob_host_monitordb_disconnected OCP-Agent cannot connect to monitordb
        • odp_instance_compress_failed
        • ob_host_mem_percent_over_threshold Host memory usage exceeds the threshold
        • monitor_exporter_unavaliable A monitoring exporter is unavailable on the server.
        • ob_host_invalid_disk_exists OBServer has a bad disk
        • host_ntp_offset_too_large The offset between the host and the NTP server is too large.
        • Host log alerts
        • host_agent_res_memory_over_threshold Server Agent Memory Over Threshold
        • odp_sql_execute_failed
        • ob_host_net_send_percent_over_threshold The server's network send bandwidth usage exceeds the threshold.
        • ob_cluster_inspection_not_passed
        • host_agent_open_fd_count_over_threshold The number of open file descriptors for the server agent exceeds the threshold.
        • obagent_dead Agent service unavailable
        • ob_cluster_recyclebin_disk_used_over_threshold
        • host_unavailable
        • ocp_http_request_too_many_errors_occur
        • ocp_http_request_timeout
        • ob_license_expired
        • base_backup_timeout
        • mgragent_process_stop ocp_mgragent process stop
        • base_backup_fail
        • monagent_process_stop
        • ssl_certificate_is_expired SSL certificate expiration alert
        • ocp_contingency_failed
      • OceanBase alerts
        • ob_cannot_connected OceanBase server cannot be connected
        • ob_cluster_rs_not_same
        • ob_cluster_status_check_failed
        • ob_cluster_exists_inactive_server OceanBase cluster has an inactive OBServer node
        • ob_cluster_exists_index_fail_table
        • ob_cluster_frozen_version_delta_over_threshold OceanBase cluster frozen version and baseline version delta exceeds threshold
        • ob_cluster_merge_error OceanBase cluster merge error
        • ob_cluster_merge_timeout OceanBase cluster merge timeout
        • ob_cluster_no_frozen OceanBase cluster not frozen for a long time
        • ob_cluster_no_merge OceanBase cluster with no major compactions for a long time
        • ob_cluster_operation_info
        • ob_cluster_sync_failed
        • ob_cpu_assigned_percent_over_threshold OceanBase has allocated more CPU resources to the tenant than allowed
        • ob_cpu_percent_over_threshold Average tenant thread usage rate exceeds the threshold on OceanBase server
        • ob_host_connection_percent_over_threshold OceanBase server connection percentage over threshold
        • ob_host_disk_readonly OceanBase server disk read-only
        • ob_host_load1_per_cpu_over_threshold OceanBase server CPU average load1 exceeds threshold
        • ob_host_partition_count_over_threshold OceanBase server partition count exceeds the threshold
        • OceanBase log alerts
        • ob_mem_assigned_percent_over_threshold OceanBase has exceeded the threshold for memory allocated to tenants.
        • ob_server_sstable_percent_over_threshold OceanBase server data disk usage over threshold
        • ob_tenant_operation_info
        • ob_tenant500_mem_hold_over_threshold OceanBase 500 tenant memory usage exceeds the threshold
        • ob_tenant500_mem_hold_percent_over_threshold OceanBase 500 tenant memory usage over threshold
        • tenant_active_memstore_percent_over_threshold OceanBase tenant active MemStore percentage over threshold
        • tenant_cpu_percent_over_threshold OceanBase tenant CPU usage exceeds threshold
        • tenant_memstore_percent_over_threshold OceanBase tenant MemStore usage percentage exceeding the threshold
        • obproxy_process_dead The OBProxy process does not exist.
        • obproxyd_process_dead
        • obproxy_cannot_connected
        • ob_cluster_sync_delay_time_too_long OceanBase cluster synchronization delay is too long
        • ob_host_data_disk_percent_over_threshold OceanBase host data disk usage over threshold
        • ob_host_log_disk_percent_over_threshold OceanBase server log directory disk usage exceeds the threshold
        • ob_host_install_disk_percent_over_threshold OceanBase server installation directory disk usage exceeds the threshold
        • ob_tenant_exists_expired_xa_trans OceanBase tenant has expired XA transactions
        • ob_cluster_active_session_count_over_threshold
        • ob_tenant_active_session_count_over_threshold
        • ob_host_active_session_count_over_threshold
        • ob_tenant_slow_sql_exists OceanBase tenant has slow SQL
        • ob_tenant_large_trans_exist OceanBase tenant has large transactions
        • same_alarm_rule_detect_too_many_targets
        • ob_tenant_expired_trans_exist OceanBase tenant has expired transactions
        • ob_tenant_long_trans_exist
        • ob_tenant_task_timeout OceanBase tenant task timeout
        • ob_host_task_timeout
        • ob_tenant_log_disk_usage_high OceanBase tenant log disk usage exceeded the limit
        • ob_tenant_no_compaction OceanBase tenant has not performed major compaction for a long time
        • ob_tenant_no_frozen OceanBase tenant has not been frozen for a long time
        • ob_tenant_compaction_error OceanBase tenant compaction error
        • host_operation
        • obproxy_host_operation
        • obproxy_cluster_operation
        • ob_host_operation
        • refresh_location_cache_failed
        • ob_tenant_log_stream_degraded OceanBase tenant has degraded log streams
        • arbitration_service_unavailable
        • observer_process_stop OBServer process stop
        • obproxyd_process_stop OBProxy daemon process stop
        • obproxy_process_stop Stop OBProxy Process
        • standby_tenant_sync_delay_too_long
        • standby_tenant_sync_status_error
        • obproxy_client_connections_usage_over_threshold OBProxy client connection usage exceeds threshold
        • ob_tenant_request_queue_over_threshold
        • oas_anomaly_sql_from_anomaly_event_analysis_cpu_percent_high
        • oas_anomaly_sql_from_anomaly_event_analysis_perf_degradation
        • oas_anomaly_sql_from_anomaly_event_analysis_plan_changed
        • oas_anomaly_sql_from_sql_inspection_perf_degradation
        • oas_anomaly_sql_from_sql_inspection_plan_changed
        • os_observer_not_exist OceanBase server process does not exist
        • refresh_location_cache_failed_by_metric
        • ob_tenant_cpu_usage_over_threshold
        • ob_tenant_partition_replica_absent OceanBase tenant partition replica absent
        • ob_tenant_partition_leader_absent
        • ob_tenant500_storage_short_meta_mem_hold_high OceanBase 500 tenant STORAGE_SHORT_TERM module memory usage exceeds the threshold
        • obproxy_core_dump OBProxy server Core Dump
        • ob_server_cannot_connect_arbitration OceanBase cluster has nodes that cannot communicate with the arbitration service
        • agent_process_count_abnormal
        • arbitration_auto_replace_operation_info
        • arbitration_group_auto_replace_failed
      • OAS alerts
        • os_cpu_irq_error Server CPU soft interrupt not scattered
        • os_tsar_cpu_sys_abnormal
        • os_observer_fd_usage OceanBase server has too many open handles
        • os_tsar_cpu_util_full
        • os_tsar_cpu_util_hwm
        • os_kernel_io_hang OceanBase server I/O Hangs
        • os_tsar_sda_ioawait OceanBase server high I/Oawait on disk SDA
        • os_tsar_nvme_ioawait OceanBase server node NVMe disk ioawait high
        • os_tsar_traffic_drop
        • os_tsar_traffic_error
        • os_observer_core_dump OceanBase server Core Dump
        • os_nic_1000m_full
        • os_nic_1000m_hwm
        • os_tsar_traffic_overload
        • node_file_root_usage High root directory usage on the server
        • node_file_inode_usage High inode usage on the server
        • os_kernel_ntp_down
        • os_kernel_ntp_delay
        • node_memory_peak
        • os_home_file_usage
        • node_file_data1_usage
        • node_file_datalog1_usage
        • sql_audit_collect_lost_percent_over_threshold
      • Appendix
        • Exception handling for OceanBase cluster compaction
        • Apply throttling to an OceanBase cluster
        • Network troubleshooting
        • Handling alert responses
    • API Reference
      • Overview
      • API call description
      • Rules for generating AK/SK signatures
      • Task return structure
      • Software packages
        • Query software packages
        • Upload a software package
        • Delete a software package
      • Cluster management
        • Query the list of OceanBase clusters
        • Create an OceanBase cluster
        • Delete an OceanBase cluster
        • Stop an OceanBase cluster
        • Start an OceanBase cluster
        • Restart an OceanBase cluster
        • Upgrade an OceanBase cluster
        • Move out an OceanBase cluster
        • Perform a takeover precheck on an OceanBase cluster
        • Take over an OceanBase cluster
        • Query zones of an OceanBase cluster
        • Create a zone for an OceanBase cluster
        • Delete a zone from an OceanBase cluster
        • Stop a zone in an OceanBase cluster
        • Start a zone in an OceanBase cluster
        • Restart a zone in an OceanBase cluster
        • Add an OBServer node
        • Delete multiple OBServers at a time
        • Stop an OBServer node
        • Start an OBServer node
        • Restart an OBServer node
        • Replace an OBServer node
        • Change the password of an OceanBase cluster
        • Query the parameter metadata of OceanBase clusters
        • Query parameters of an OceanBase cluster
        • Modify parameters of an OceanBase cluster
        • Query OBServer nodes of an OceanBase cluster
        • Query OBServer nodes in a zone
        • Perform a switchover pre-check
        • Perform a failover pre-check
        • Perform a switchover
        • Perform a failover
        • Query resource statistics of an OceanBase cluster
        • Query resource statistics of all OBServer nodes in an OceanBase cluster
        • Query units of an OceanBase cluster
        • Create an arbitration service
        • Query details of an arbitration service
        • Query the list of arbitration services
        • Stop an arbitration service
        • Start an arbitration service
        • Restart an arbitration service
        • Upgrade an arbitration service
        • Delete an arbitration service
        • Query arbitration service parameters
        • Bind/Unbind tags to/from an arbitration service
        • Perform an arbitration service takeover precheck
        • Take over an arbitration service
        • Migrate an arbitration service
        • Perform a precheck on batch arbitration service replacement
        • Replace the arbitration service for multiple clusters
        • Perform an association precheck on multiple OceanBase clusters
        • Associate an arbitration service with multiple OceanBase clusters
        • Dissociate an arbitration service from multiple clusters
        • Create an arbitration service group
        • Update an arbitration service group
        • Query information of an arbitration service group
        • Query the list of arbitration service groups
        • Delete an arbitration service group
        • Upgrade an arbitration service group
      • Database management
        • Grant database privileges to a user
        • Query database objects
        • Query the list of database roles
        • Grant global privileges to a role
        • Change global privileges of a role
        • Query database user details
        • Change database privileges of a user
        • Delete a database user
        • Query databases
        • Revoke database privileges of a user
        • Grant roles to a role
        • Change roles of a role
        • Create a database user
        • Create a database role
        • Lock a database user
        • Query database role details
        • Delete a database role
        • Revoke roles of a user
        • Query the list of database users
        • Delete a database
        • Revoke object privileges of a user
        • Revoke roles of a role
        • Change global privileges of a user
        • Unlock a database user
        • Change the password of a database user
        • Modify a database
        • Grant object privileges to a role
        • Create a database
        • Change roles of a user
        • Revoke global privileges of a role
        • Change object privileges of a user
        • Grant global privileges to a user
        • Revoke global privileges of a user
        • Grant roles to a user
        • Grant object privileges to a user
        • Change object privileges of a role
        • Revoke object privileges of a role
      • System management
        • Health examination
          • Query the basic information of an OCP application
          • Query OCP server time
          • Query OCP application status
        • Operation Audit
          • Query historical events
        • Agent management
          • Stop the OCP Agent process on a host
          • Stop the OCP Agent process on a host
          • Restart the OCP Agent process on a host
          • Query OCP Agent details on a host
          • Batch stop the OCP Agent processes on hosts
          • Batch restart the OCP Agent processes on hosts
          • Restart the OCP Agent process on a host
          • Query OCP Agent processes on a host
      • SQL performance
        • Query the performance indicator trend of an SQL statement
        • Query performance metrics of an SQL statement
        • Query a performance report
        • Query the operator structure of an execution plan
        • Query the list of slow SQL statements
        • Query SQL text
        • Generate a performance report
        • Query snapshots
        • Query the performance indicator trend of an execution plan
      • O&M tasks management
        • Query details about a task
        • Query tasks
        • Retry a task
        • Cancel a subtask
        • Roll back a task
        • Retry a subtask
        • Query subtask logs
        • Skip a subtask
      • Backup and recovery
        • View the log backup tasks of a tenant
        • View the data backup tasks of a tenant
        • Delete the backup strategy of a cluster
        • Parse the backup information of a tenant
        • Initiate tenant recovery
        • View restore tasks
        • Query the backup strategy of a tenant
        • Start backup scheduling for a cluster
        • Clear added restore resources
        • Query recovery tasks of a cluster
        • Stop backup scheduling for a tenant
        • Query the backup overview of a cluster
        • Modify the backup strategy of a cluster
        • Query backup capabilities of a cluster
        • Query the backup strategy of a cluster
        • Create a backup strategy for a tenant
        • Parse cluster backup data
        • Initiate a data backup for a tenant
        • Modify the backup strategy of a tenant
        • Query data backup tasks of a cluster
        • Start backup scheduling for a tenant
        • Add restore resources
        • Create a backup strategy for a cluster
        • Immediately back up a cluster
        • Preview a restore task
        • Delete the backup strategy of a tenant
        • Stop backup scheduling for a cluster
        • Query log backup tasks of a cluster
      • OBProxy management
        • Update configurations of an OBProxy cluster
        • Restart an OBProxy
        • Upgrade an OBProxy
        • Remove a connectable OceanBase cluster from an OBProxy cluster
        • Create an OBProxy cluster
        • Query the description information of the OBProxy parameters
        • Delete an OBProxy (not recommended)
        • Start an OBProxy
        • Query details about an OBProxy cluster
        • Add an OBProxy
        • Take over an OBProxy
        • Stop an OBProxy
        • Add a connectable OceanBase cluster to an OBProxy cluster
        • Query parameters of an OBProxy cluster
        • Upgrade an OBProxy
        • Delete an OBProxy cluster
        • Query OBProxy clusters
        • Delete an OBProxy
        • Restart an OBProxy
      • Tenant management
        • Create a tenant
        • Modify a replica of a tenant
        • Modify parameters of a tenant
        • Query tenants of a cluster
        • Create a standby tenant
        • Obtain a list of unit specifications
        • Delete a unit from a tenant
        • Perform a batch failover
        • Add a replica for a tenant
        • Create a resource unit specification
        • Perform a batch switchover
        • Unlock a tenant
        • Perform a switchover
        • Perform a failover precheck
        • Query all tenants
        • Query parameters of a tenant
        • Delete a replica of a tenant
        • Change the administrator password of a tenant
        • Delete a resource unit specification
        • Perform a batch switchover precheck
        • Query details about a tenant
        • Modify the allowlist of a tenant
        • Perform a switchover precheck
        • Lock a tenant
        • Perform a batch failover precheck
        • Modify zone priorities of a tenant
        • Query units of a tenant
        • Delete a tenant
        • Perform a failover
      • Inspection
        • Query all inspection tasks
        • Query inspection objects
        • View the details of an inspection report
        • Initiate an inspection
        • Query the last inspection result of an inspection item
        • Query the last inspection result of an inspection object
      • Host management
        • Query regions
        • Query details about a region
        • Add region information
        • Delete a region
        • Query IDCs
        • Query details about an IDC
        • Add IDC information
        • Delete an IDC
        • Query host types
        • Query details about a host type
        • Add host type information
        • Delete a host type
        • Query hosts
        • Query details about a host
        • Add multiple hosts at a time
        • Delete a host
        • Delete multiple hosts at a time
      • Alerts
        • Call an alert API
        • Alert events
          • Query the alert event list
          • Query alert events
        • Alert notifications
          • Query alert notifications
      • Monitoring
        • Query the description of a monitoring metric
        • Query monitoring data
        • Query monitoring data by tag
    • Metric reference
      • Overview of metrics
      • Monitoring metrics list
      • OBProxy cluster
        • TPS
        • QPS
        • Client connections
        • Server connections
        • Average response time for each SQL statement
        • Memory for the obproxy process
        • OBProxy CPU usage
        • Number of file descriptors for the obproxy process
        • Number of threads in the obproxy process
        • Log error
        • Route table queries
        • Net bytes
        • RPC sessions
        • RPC requests
        • RPC request time consumption
      • OceanBase Database tenant
        • Performance and SQL
          • QPS
          • Response time (SQL mode)
          • SQL execution plan category
          • SQL execution plan time
          • Sessions
          • Wait events
          • Metrics related to time consumption of wait events
          • Request waiting queue
          • Request waiting queue time consuming
          • Request queue size
          • Tenant CPU cost
          • Tenant thread usage
          • memroy usage pecent
          • MemStore usage
          • Rpc package rt
          • RPC packet throughput
          • Cursors
          • Clog synchronization delay
          • DB time metrics
          • SQL execution phase
          • Frontend workload
          • Background workload metrics
          • PX worker thread usage
        • Transaction
          • TPS
          • Transaction response time
          • Transaction response time details
          • Number of transaction logs
          • Transaction log volume
          • Time consumed by transaction logs
          • Lock waits
          • Time consumed by lock waits
          • TPS
          • Transaction table read request hits
          • Partition
          • XA Transactions
          • XA Statement Count
          • Average execution duration of XA statements
        • Storage and Cache
          • MemStore
          • IOPS
          • IO time-consuming
          • I/O Throughput
          • Cache size
          • Cache hit rates
          • Number of cache requests
          • Frozen MEMStore
          • # Log disk
          • # Data disk
        • Database objects
          • Objects
        • OBKV_Table
          • Response time (OBKV-Table)
          • Average number of statement lines processed (OBKV-Table)
          • QPS (OBKV-Table)
        • OBKV_HBase
          • QPS (OBKV_Hbase)
          • Response time (OBKV-HBase)
          • Average number of statement lines processed (OBKV-HBase)
        • OBKV_Redis
          • Response time (OBKV-Redis)
          • QPS (OBKV-Redis)
      • Host
        • Host Performance
          • Linux system load
          • CPU Utilization
          • I/O usage
          • I/O queue length
          • IOPS
          • Time consumed by I/O operations
          • I/O throughput
          • Network throughput
          • TCP retransmission rate
          • Packet forwarding
          • NTP clock offset
          • Inode usage
        • Host Resources
          • Memory
          • Memory usage
          • Disk
        • Host Processes
          • Number of process file descriptors
          • Process resident memory
          • Number of process threads
          • Number of OCP-Agent process goroutines
          • Process CPU utilization
      • OceanBase cluster
        • Database performance
          • Query response time
          • I/O Throughput
          • Request queue time
          • Number of sessions
          • IOPS
          • Transaction response time
          • Number of transaction logs
          • QPS
          • Time consumed by transaction logs
          • TPS
          • TPS
          • Transaction log volume
          • IO time-consuming
        • OBServer performance
          • Error logs
          • Number of process threads
          • Process memory
          • Process file descriptors
          • Process CPU utilization
          • sys500 memory occupation
      • Binlog Service
        • Subscription Connection Monitoring
          • Sending Delay
          • Associate RPS
          • Network Traffic
        • Binlog Resource Monitoring
          • CPU
          • memory used
          • memory
          • disk used
          • Binlog Disk Write Rate
          • disk ratio
          • FD count
          • network bytes
        • Binlog Performance Monitoring
          • Binlog Delay
          • Binlog RPS
    • Information Collection Reference
      • Major Compaction Exceptions
        • Collect the last-one-day records of major compaction events scheduled by RootService
        • Collect major compaction parameter settings
        • Collect diagnostic information about major compactions
        • Collect the checksum information about tablets
        • Collect information about the major compaction status of zones of a cluster
        • Collect the major compaction time
        • Collect RootService task records
        • Collect the checksum information about columns
        • Collect information about the ongoing major compaction in a cluster
        • Collect suggestions provided based on historical major compactions
        • Collect information about DAG warnings in OceanBase Database
      • OCP Agent Exceptions
        • Collect panic logs of the mgragent process
        • Collect information about goroutines of the agent processes
        • Collect panic logs of the monagent process
      • Cluster Exceptions
        • Collect information about bad disks
        • Collect information about OBServer nodes in a cluster
        • Collect obstack information on a cluster node
        • Collect information about the core dump file of the observer process
        • Collect host logs containing the CRASH ERROR keyword
        • Collect connectivity information of the sys tenant
      • CPU Exceptions
        • Collect information about threads with high CPU utilization in an observer process
        • Collect information about processes with high CPU utilization on a cluster node
      • Data Disk Full
        • Collect information about the disk space occupied by temporary files of a tenant
        • Collect incremental data generated during cluster compactions
        • Collect information about sizes of data of different versions in major SSTables
        • Collect information about the macroblock utilization of nodes
        • Collect the data disk usage information of nodes in a cluster
      • Memory Exceptions
        • Collect information about modules with highest memory usage
        • Collect memory allocation sampling data of OBServer nodes
        • Collect KV cache information of a tenant
        • Collect memory leakage detection information
        • Collect MemStore information of a tenant
      • Host Exceptions
        • Collect logs from the /var/log/messages directory of a host
        • Collect host information by running the df -h command
      • Other Tenants Exceptions
        • Collect host logs containing the dump tenant info keyword
        • Collect host logs containing the dump tenant disk usage keyword
        • Collect host logs containing the dump tenant info keyword
    • Error codes reference
      • OCP error codes
      • OBServer error codes
        • MySQL mode
          • 10000 to 12000
          • 4000 to 4499
          • 4500 to 4999
          • 6000 to 6999
          • 7000 to 7999
          • 9000 to 9499
          • 5000 to 5999
          • 9500 to 9999
          • 8000 to 8999
          • 22998, 30926, 38104, and 38105
          • Overview
          • 0001 to 3999
        • Oracle mode
          • OBE-00000 to OBE-00999
          • OBE-20000 to OBE-29999
          • Overview
          • OBE-10000 to OBE-19999
          • OBE-30000 to OBE-49999
          • OBE-02000 to OBE-04999
          • PLS-00000 to PLS-00999
          • OBE-50000 to OBE-99999
          • OBE-01500 to OBE-01999
          • OBE-05000 to OBE-10000
          • OBE-01000 to OBE-01499
  • FAQ
    • FAQ about deployment
    • FAQ on upgrade
    • FAQ on O&M
      • FAQ on backup and recovery
      • FAQ on the OCP software package
      • FAQ about OceanBase clusters
      • FAQ on OBProxy
      • FAQ about OceanBase tenants
      • FAQ on accounts and passwords
      • FAQ on host management
    • FAQ on monitoring
      • FAQ on monitoring metrics
      • FAQ on SQL monitoring
      • FAQ about resource usage
      • Use OCP-Agent to pull time-series monitoring data
    • FAQ on alerts
    • FAQ on the OCP system
    • OCP multi-cluster FAQ
  • Appendix
    • AWS S3 protocol
    • Install and configure OCI
    • Component listening port list
    • Processes
    • OCP background tasks
    • Grafana dashboard
    • Modify the log stream downgrade control time
    • Tables managed by the daemon
  • Release Notes
    • V4.3
      • OCP V4.3.6
      • OCP V4.3.4
      • OCP V4.3.1
      • OCP V4.3.0
      • OCP V4.3.5
      • OCP V4.3.3
      • OCP V4.3.2
    • V4.0
      • OCP V4.0.3

Download PDF

Product Updates What is OceanBase Cloud Platform Differences between Enterprise Edition and Community Edition System architecture Features System requirements Dependencies Installation process Prepare for the installation Overview Post-deployment check Use Docker to deploy OCP Deploy OCP on the GUI Overview Considerations Preparations Post-upgrade check Upgrade OCP on the GUI Upgrade OCP using Docker containers OCP operations Log on to the OCP console Upload a software package Add hosts Create a cluster Create a primary tenant Create a user Create an OBProxy cluster Upgrade version View the topology of a clusterOverview of cluster tenant management Overview Manage cluster parameter templates Create a standby cluster View details of a cluster Scale a standalone system to a distributed cluster Take over a cluster Restart a cluster Stop a cluster Move out a cluster Delete a cluster Change the password Enable automatic detection of deadlocks Disable automatic detection of deadlocks Manage CPU binding configurations Import a license View the license Edit an arbitration service group Create an arbitration service group Delete an arbitration service group Overview Upgrade an arbitration service group Add an OBServer node Restart a faulty OBServer node Stop an OBServer service Stop an observer process Replace an OBServer node Reinstall an OBServer Delete an OBServer Add a zone Edit a zone Restart a zone Stop a zone Delete a zone Arbitration service Overview Create an arbitration service Take over an arbitration service Stop an arbitration service Start an arbitration service Upgrade an arbitration service Restart an arbitration service Migrate an arbitration service Replace an arbitration service Associate a cluster Dissociate an arbitration service Delete an arbitration service View the unit distribution View resource usage Parameter types View parameters Modify parameters View the history of parameter changes Modify the major compaction settings of a cluster Perform a major compaction View details of a major compaction View statistics of a major compaction View the major compaction records Create a distributed cluster Create a standalone deployment Manage Transparent Data Encryption (TDE) Tenant and resource management Create a primary tenant Manage tenant parameter templatesView OCP resource unit specifications Manage unit specifications Manage databases Manage the resources of a tenant View tenant overview information Overview Create a standby tenant Copy a tenant
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Cloud Platform
  3. V4.3.6
iconOceanBase Cloud Platform
V 4.3.6
  • V 4.3.6
  • V 4.3.5
  • V 4.3.4
  • V 4.3.3
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.2
  • V 4.0.0 and earlier

Query historical events

Last Updated:2026-04-03 03:16:02  Updated
share
What is on this page
Feature description
Call instructions
Interface constraints
Request path
Parameters
Returned result
Example
Request example
Response example

folded

share

Feature description

Queries historical events of OCP. You can query historical events by specifying parameters such as event type, operation name, resource name, operator ID, event information, event status, and time range.

Call instructions

Interface constraints

  • The caller needs to be authenticated through OCP Application Service.

  • The caller needs to have the permission to view historical events (AUDIT VIEWER).

Request path

GET /api/v2/audit/events

Parameters

Parameter Type Required Example value Description
eventType StringArray No COMPUTE_HOST_MANAGEMENT,OB_CLUSTER_MANAGEMENT For more information, see Event type.
operationEvent StringArray No ADD_OB_ZONES, DELETE_OB_ZONES For more information, see Operation Events.
resourceName String No my_ob_cluster The name of the resource, which is used for managing the cluster, backing up and restoring the data, and is the name of the cluster. If it is for managing the host, the name is the IP address of the host. If it is for managing the tenant, the name is cluster name:tenant name. If it is for managing the OCP user, the name is the username of the OCP user. If it is for managing the OCP cluster, the name is the name of the OCP cluster.
operatorId LongArray No 1,2,3 The ID of the operator, which corresponds to the OCP user ID.
eventInfo String None {"clusterId":1} Event information, corresponding to the request parameters when an operation event occurs.
status String N/A SUCCESS The current status of the event. Valid values: SUCCESS and FAILED.
startTime OffsetDateTime Required 2021-09-07T19:04:42.768+08:00 The start time of the time period during which the event occurred.
endTime OffsetDateTime No 2021-09-08T19:04:42.768+08:00 The end time of the event occurrence period.
page Integer No 1 The page number for pagination.
size Integer No 10 The number of rows per page.
order String N startTime,desc The parameters for sorting and pagination.

Event Type

Event Type Type Description
COMPUTE_HOST_MANAGEMENT Host Management.
OB_CLUSTER_MANAGEMENT OceanBase Cluster Management.
ARBITRATION_SERVICE_MANAGEMENT Arbitration service management.
ARBITRATION_SERVICE_GROUP_MANAGEMENT Manage arbitration service groups.
OB_TENANT_MANAGEMENT Tenant Management
OB_PROXY_CLUSTER_MANAGEMENT ObProxy Cluster Management.
BINLOG_SERVICE_MANAGEMENT Binlog Service Management.
BACKUP_RESTORE Backup and restore.
SOFTWARE_PACKAGE_MANAGEMENT Software Package Management.
OCP_USER_MANAGEMENT OCP User Management.
OCP_CLUSTER_MANAGEMENT OCP Cluster Management.
CREDENTIAL_MANAGEMENT Credential management.
ALARM_MANAGEMENT Alarm Management.
INSPECTION_MANAGEMENT Inspection Management.
PROFILE_MANAGEMENT Manage personal information.
MONITOR_CUSTOMIZE_MANAGEMENT Monitor customization.
MONITOR_DASHBOARD_MANAGEMENT Monitor Dashboard Management.
OCP_PROPERTY_MANAGEMENT OCP parameter management.
TAG_MANAGEMENT Manage labels.
SQL_PERF_MANAGEMENT SQL Performance Management.
ORGANIZATION_MANAGEMENT Organize management.
CONTINGENCY_MANAGEMENT Contingency Management.
COLLECTIONS_MANAGEMENT Information Collection Management.
REPORT_CENTER_MANAGEMENT Manage Report Center.
CERTIFICATE_MANAGEMENT Certificate Management.
AI_ASSISTANT_MODEL_MANAGEMENT Manages AI assistant models.

Operation Events

Incident Description Event Type Description
ADD_HOSTS COMPUTE_HOST_MANAGEMENT Adds a host.
DELETE_HOSTS COMPUTE_HOST_MANAGEMENT Delete host.
BATCH_DELETE_HOSTS COMPUTE_HOST_MANAGEMENT Batch delete hosts.
UPDATE_HOST COMPUTE_HOST_MANAGEMENT Modify the information about the host.
INSTALL_OCP_AGENT COMPUTE_HOST_MANAGEMENT Installs OCP-Agent.
STOP_OCP_AGENT COMPUTE_HOST_MANAGEMENT Stop OCP Agent.
RESTART_OCP_AGENT COMPUTE_HOST_MANAGEMENT Restart OCP-Agent.
REINSTALL_OCP_AGENT COMPUTE_HOST_MANAGEMENT Reinstall OCP-Agent.
BATCH_REINSTALL_OCP_AGENT COMPUTE_HOST_MANAGEMENT Reinstall OCP-Agent in batch.
CREATE_OB_CLUSTER OB_CLUSTER_MANAGEMENT Creates an OceanBase cluster.
START_OB_CLUSTER OB_CLUSTER_MANAGEMENT Start OceanBase cluster.
START_OB_CLUSTER_IN_READ_ONLY OB_CLUSTER_MANAGEMENT Start OceanBase cluster in read-only mode.
STOP_OB_CLUSTER OB_CLUSTER_MANAGEMENT Stop an OceanBase cluster.
RESTART_OB_CLUSTER OB_CLUSTER_MANAGEMENT Restart an OceanBase cluster.
UPGRADE_OB_CLUSTER OB_CLUSTER_MANAGEMENT Upgrade OceanBase cluster.
DELETE_OB_CLUSTER OB_CLUSTER_MANAGEMENT Delete an OceanBase cluster.
TAKE_OVER_OB_CLUSTER OB_CLUSTER_MANAGEMENT Take over OceanBase clusters.
MOVE_OUT_OB_CLUSTER OB_CLUSTER_MANAGEMENT Move out an OceanBase cluster.
SWITCHOVER_OB_CLUSTER OB_CLUSTER_MANAGEMENT routine switching
FAILOVER_OB_CLUSTER OB_CLUSTER_MANAGEMENT Failover management.
DISCONNECT_STANDBY_OB_CLUSTER OB_CLUSTER_MANAGEMENT Disconnects a standby cluster.
UPDATE_OB_CLUSTER_PARAMETERS OB_CLUSTER_MANAGEMENT Modify parameters of an OceanBase cluster.
CHANGE_OB_CLUSTER_PASSWORD OB_CLUSTER_MANAGEMENT Modifies the password of an OceanBase cluster.
UPDATE_OB_CLUSTER_STATUS OB_CLUSTER_MANAGEMENT Modifies the status of OceanBase clusters.
ADD_OB_SERVERS OB_CLUSTER_MANAGEMENT Add an OBServer.
BATCH_ADD_OB_SERVERS OB_CLUSTER_MANAGEMENT Add OBServer in batches.
DELETE_OB_SERVERS OB_CLUSTER_MANAGEMENT Deletes an OBServer.
START_OB_SERVER OB_CLUSTER_MANAGEMENT Start OBServer.
STOP_OB_SERVER OB_CLUSTER_MANAGEMENT Stop the OBServer.
RESTART_OB_SERVER OB_CLUSTER_MANAGEMENT Restart the OBServer.
BATCH_DELETE_OB_SERVERS OB_CLUSTER_MANAGEMENT Batch delete OBServer.
REPLACE_OB_SERVER OB_CLUSTER_MANAGEMENT Replace an OBServer node.
ADD_OB_ZONES OB_CLUSTER_MANAGEMENT Add OBZones.
BATCH_ADD_OB_ZONES OB_CLUSTER_MANAGEMENT Batch add OBZones.
DELETE_OB_ZONES OB_CLUSTER_MANAGEMENT Deletes OBZones.
STOP_OB_ZONES OB_CLUSTER_MANAGEMENT Stop OBZones.
START_OB_ZONES OB_CLUSTER_MANAGEMENT Start OBZones.
RESTART_OB_ZONES OB_CLUSTER_MANAGEMENT Restart OBZones.
PATCH_COMPACTION_SETTINGS OB_CLUSTER_MANAGEMENT Update cluster compaction settings.
ADD_OB_ARBITRATION_SERVICE OB_CLUSTER_MANAGEMENT Associated arbitration service.
REMOVE_OB_ARBITRATION_SERVICE OB_CLUSTER_MANAGEMENT Disassociates the arbitration service.
REPLACE_OB_ARBITRATION_SERVICE OB_CLUSTER_MANAGEMENT Replace the arbitration service.
MODIFY_TOP_SQL_SWITCH OB_CLUSTER_MANAGEMENT Enable or disable the Top SQL switch.
MODIFY_DEADLOCK_DETECTION_SWITCH OB_CLUSTER_MANAGEMENT Modify the deadlocks detection switch.
TRIGGER_OB_CLUSTER_COMPACTION OB_CLUSTER_MANAGEMENT Trigger OceanBase Cluster Major Compaction.
CLEAR_OB_CLUSTER_COMPACTION_ERROR_FLAG OB_CLUSTER_MANAGEMENT Clears the status of failed OceanBase compaction.
SWITCH_CLUSTER_CGROUP OB_CLUSTER_MANAGEMENT Enable/Disable the cgroup for a cluster.
MODIFY_ZONE_IDC OB_CLUSTER_MANAGEMENT Modify the IDC of the zone.
CREATE_OB_PROXY_CLUSTER OB_PROXY_CLUSTER_MANAGEMENT Create an OBProxy cluster.
DELETE_OB_PROXY_CLUSTER OB_PROXY_CLUSTER_MANAGEMENT Delete an OBProxy cluster.
UPGRADE_OB_PROXIES OB_PROXY_CLUSTER_MANAGEMENT Upgrade OBProxy.
ADD_OB_PROXIES OB_PROXY_CLUSTER_MANAGEMENT Add OBProxy.
MOVE_OUT_OB_PROXY OB_PROXY_CLUSTER_MANAGEMENT Migrate the OBProxy cluster.
RESTART_OB_PROXIES OB_PROXY_CLUSTER_MANAGEMENT Forces a restart of the OBProxy instance.
START_OB_PROXIES OB_PROXY_CLUSTER_MANAGEMENT Start OBProxy.
STOP_OB_PROXIES OB_PROXY_CLUSTER_MANAGEMENT Stops an OBProxy.
HOT_RESTART_OB_PROXIES OB_PROXY_CLUSTER_MANAGEMENT Restart an OBProxy.
DELETE_OB_PROXIES OB_PROXY_CLUSTER_MANAGEMENT Deletes an OBProxy instance.
PATCH_OB_PROXY_CLUSTER OB_PROXY_CLUSTER_MANAGEMENT Modify the configurations of an OBProxy cluster.
MODIFY_OB_PROXY_PARAMETERS OB_PROXY_CLUSTER_MANAGEMENT Modify OBProxy cluster parameters.
ADD_OB_PROXY_OB_LINK OB_PROXY_CLUSTER_MANAGEMENT Add an OBLink.
LOCK_OB_PROXY_CLUSTER_STATUS OB_PROXY_CLUSTER_MANAGEMENT Locks an OBProxy cluster.
UNLOCK_OB_PROXY_CLUSTER_STATUS OB_PROXY_CLUSTER_MANAGEMENT Unlock the OBProxy cluster.
BATCH_ADD_OB_PROXY_OB_LINK OB_PROXY_CLUSTER_MANAGEMENT Batch Add OBLink.
PATCH_OB_OB_PROXY_OB_LINK OB_PROXY_CLUSTER_MANAGEMENT Modify OBLink.
DELETE_OB_PROXY_OB_LINK OB_PROXY_CLUSTER_MANAGEMENT Delete an OBLink.
CHANGE_PROXY_SYS_PASSWORD OB_PROXY_CLUSTER_MANAGEMENT Change the proxysys password.
CHANGE_PROXYRO_PASSWORD OB_PROXY_CLUSTER_MANAGEMENT Modify the password of proxyro.
CREATE_TENANT OB_TENANT_MANAGEMENT Create a tenant.
CREATE_TENANT_ASYNC OB_TENANT_MANAGEMENT Asynchronously create a tenant.
CLONE_TENANT OB_TENANT_MANAGEMENT Clone Tenant.
DELETE_TENANT OB_TENANT_MANAGEMENT Deletes a tenant.
RENAME_TENANT OB_TENANT_MANAGEMENT Rename tenant.
LOCK_TENANT OB_TENANT_MANAGEMENT Lock Tenant.
UNLOCK_TENANT OB_TENANT_MANAGEMENT Unlock a tenant.
MODIFY_TENANT_PARAMETERS OB_TENANT_MANAGEMENT Modify Tenant Parameters.
CHANGE_TENANT_PASSWORD OB_TENANT_MANAGEMENT Change tenant password.
MODIFY_TENANT_PRIMARY_ZONE OB_Tenant_Management Updates the Primary Zone of a Tenant.
MODIFY_TENANT_WHITE_LIST OB_TENANT_MANAGEMENT Update tenant allowlist.
ADD_REPLICA OB_TENANT_MANAGEMENT Add a replica.
DELETE_REPLICA OB_TENANT_MANAGEMENT Delete a replica.
MODIFY_REPLICA OB_TENANT_MANAGEMENT Modify replica.
DELETE_UNIT OB_TENANT_MANAGEMENT Delete the resource unit.
CREATE_DATABASE OB_TENANT_MANAGEMENT Create a database.
MODIFY_DATABASE OB_TENANT_MANAGEMENT Modify the database.
DELETE_DATABASE OB_TENANT_MANAGEMENT Delete a database.
CREATE_DATABASE_USER OB_TENANT_MANAGEMENT Create a database user.
DELETE_DATABASE_USER OB_TENANT_MANAGEMENT Delete a database user.
GRANT_GLOBAL_PRIVILEGE OB_TENANT_MANAGEMENT Grants global privileges to a user.
REVOKE_GLOBAL_PRIVILEGE OB_TENANT_MANAGEMENT Revokes privileges granted to the user on a global scale.
MODIFY_GLOBAL_PRIVILEGE OB_TENANT_MANAGEMENT Modify user privileges.
GRANT_DB_PRIVILEGE OB_TENANT_MANAGEMENT Grants the user the DB privilege.
REVOKE_DB_PRIVILEGE OB_TENANT_MANAGEMENT Revoke Database Privileges.
GRANT_OBJECT_PRIVILEGE_TO_USER OB_TENANT_MANAGEMENT Grants object privileges on specified objects to the specified user.
REVOKE_OBJECT_PRIVILEGE_FROM_USER OB_TENANT_MANAGEMENT Revoke privileges on objects.
MODIFY_OBJECT_PRIVILEGE_FROM_USER OB_TENANT_MANAGEMENT Modify object privileges.
CHANGE_DB_USER_PASSWORD OB_TENANT_MANAGEMENT Change the password of a user.
LOCK_DATABASE_USER OB_TENANT_MANAGEMENT Locks the database user.
UNLOCK_DATABASE_USER OB_TENANT_MANAGEMENT Unlock the database user.
GRANT_OBJECT_PRIVILEGE_TO_ROLE OB_TENANT_MANAGEMENT Grants a role privileges on an object.
REVOKE_OBJECT_PRIVILEGE_FROM_ROLE OB_TENANT_MANAGEMENT Revoke the privilege on an object granted to a role.
MODIFY_OBJECT_PRIVILEGE_FROM_ROLE OB_TENANT_MANAGEMENT Modify object privileges of a role.
MODIFY_DATABASE_PRIVILEGE OB_TENANT_MANAGEMENT Modify database privileges.
ENABLE_ARBITRATION OB_TENANT_MANAGEMENT Enable arbitration.
DISABLE_ARBITRATION OB_TENANT_MANAGEMENT Disable arbitration.
CREATE_STANDBY_TENANT OB_TENANT_MANAGEMENT Creates a standby tenant.
START_LOG_TRANSPORT OB_TENANT_MANAGEMENT Enables log transport.
SUSPEND_LOG_TRANSPORT OB_TENANT_MANAGEMENT Suspend log transport.
SWITCHOVER_OB_TENANT OB_TENANT_MANAGEMENT Daily tenant switchover
BATCH_SWITCHOVER_OB_TENANT OB_TENANT_MANAGEMENT Tenant batch daily switchover.
FAILOVER_OB_TENANT OB_TENANT_MANAGEMENT Tenant disaster recovery.
BATCH_FAILOVER_OB_TENANT OB_TENANT_MANAGEMENT Batch failover of an OceanBase tenant.
DISCONNECT_OB_TENANT OB_TENANT_MANAGEMENT Disconnect a tenant.
START_TENANT_LOG_BACKUP OB_TENANT_MANAGEMENT Enable tenant log backup.
CREATE_SERVICE_NAME OB_TENANT_MANAGEMENT Specifies the name of the service to be created.
DELETE_SERVICE_NAME OB_TENANT_MANAGEMENT The name of the service to be deleted.
MODIFY_SERVICE_NAME OB_TENANT_MANAGEMENT Modify service name.
CREATE_SAMPLING_INSPECT_STRATEGY BACKUP_RESTORE Create a sampling inspection strategy.
CREATE_CLUSTER_BACKUP_STRATEGY BACKUP_RESTORE Creates a cluster backup strategy.
CREATE_BACKUP_STRATEGY BACKUP_RESTOR Create a backup strategy.
START_CLUSTER_DATA_BACKUP BACKUP_RESTORE Initiate cluster data backup.
START_DATA_BACKUP BACKUP_RESTORE Initiate data backup.
START_LOG_BACKUP BACKUP_RESTORE Initiates a log backup.
STOP_LOG_BACKUP BACKUP_RESTORE Stop log backup.
RESUME_LOG_BACKUP BACKUP_RESTORE Enable log backup.
SUSPEND_LOG_BACKUP BACKUP_RESTORE Suspend log backup.
START_CLUSTER_RESTORE_TENANT BACKUP_RESTORE Initiates tenant-level restore.
START_RESTORE_TENANT BACKUP_RESTORE Initiate tenant restore.
START_TENANT_RESTORE_TENANT BACKUP_RESTORE Initiate tenant-level restore.
CREATE_USER OCP_USER_MANAGEMENT Create an OCP user.
DELETE_USER OCP_USER_MANAGEMENT Delete an OCP user.
CREATE_ROLE OCP_USER_MANAGEMENT Create an OCP role.
UPDATE_ROLE OCP_USER_MANAGEMENT Modify an OCP role.
DELETE_ROLE OCP_USER_MANAGEMENT Delete an OCP role.
UPDATE_USER OCP_USER_MANAGEMENT Modify an OCP user.
CHANGE_USER_PASSWORD OCP_USER_MANAGEMENT Change the password of the OCP user.
TAKE_OVER_OB_PROXY OB_PROXY_CLUSTER_MANAGEMENT Take over OBProxy.
DELETE_SOFTWARE_PACKAGE SOFTWARE_PACKAGE_MANAGEMENT Delete a software package.
BATCH_DELETE_SOFTWARE_PACKAGE SOFTWARE_PACKAGE_MANAGEMENT Batch delete software packages.
TRANSFER_STANDALONE_TO_DISTRIBUTED OB_CLUSTER_MANAGEMENT Transfers a single-node deployment to a distributed cluster.
CREATE_CREDENTIAL CREDENTIAL_MANAGEMENT Creates a credential.
UPDATE_CREDENTIAL CREDENTIAL_MANAGEMENT Update credentials.
DELETE_CREDENTIAL CREDENTIAL_MANAGEMENT Delete credential.
BATCH_DELETE_CREDENTIAL CREDENTIAL_MANAGEMENT Batch delete credentials.
EXPORT_CREDENTIAL CREDENTIAL_MANAGEMENT Export the credential.
IMPORT_CREDENTIAL CREDENTIAL_MANAGEMENT Import credential.
UPDATE_OBCLUSTER_AGENT_CONFIG_PARAMETERS OB_CLUSTER_MANAGEMENT Modify OceanBase cluster agent parameter configuration.
RESET_OBCLUSTER_AGENT_CONFIG_PARAMETERS OB_CLUSTER_MANAGEMENT Resets OceanBase cluster agent parameter configurations.
UPDATE_HOST_AGENT_CONFIG_PARAMETERS COMPUTE_HOST_MANAGEMENT Modify the parameters of the host Agent.
RESET_HOST_AGENT_CONFIG_PARAMETERS COMPUTE_HOST_MANAGEMENT Resets the parameters of the host Agent.
UPDATE_CLUSTER_LOAD_TYPE OB_CLUSTER_MANAGEMENT Modifies the cluster load type.
BATCH_INACTIVE_AGENTS COMPUTE_HOST_MANAGEMENT Batch Inactive Agents.
BATCH_ACTIVE_AGENTS COMPUTE_HOST_MANAGEMENT Batch active agents.
AUTO_REINSTALL_HOST_AGENT COMPUTE_HOST_MANAGEMENT Reinstall the OCP-Agent
REFRESH_HOST_AGENT_CONFIGS COMPUTE_HOST_MANAGEMENT Refreshes the configurations of all agents.
PUT_MODULE_CONFIG_CHANGE COMPUTE_HOST_MANAGEMENT Add the definition for Agent module_config change.
BATCH_RESTART_AGENTS COMPUTE_HOST_MANAGEMENT Batch restarts the OCP-Agents on the specified host.
BATCH_STOP_AGENTS COMPUTE_HOST_MANAGEMENT To batch stop OCP-Agents.
DISABLE_MY_ACCESS_KEY PROFILE_MANAGEMENT Disable Personal Access Key.
DELETE_MY_ACCESS_KEY PROFILE_MANAGEMENT Delete the AccessKey.
CREATE_MY_ACCESS_KEY PROFILE_MANAGEMENT Create AccessKey.
ENABLE_MY_ACCESS_KEY PROFILE_MANAGEMENT Enable your AccessKey.
CHANGE_PASSWORD PROFILE_MANAGEMENT Change user password.
UPDATE_PROFILE PROFILE_MANAGEMENT Modify your personal information.
CREATE_ALARM ALARM_MANAGEMENT Generates an alarm event.
CREATE_ALARM_FILTER ALARM_MANAGEMENT Create an alarm filter.
CREATE_ALARM_GROUP ALARM_MANAGEMENT Creates an alert group.
CLONE_ALARM_GROUP ALARM_MANAGEMENT Copy an Alarm Group.
CREATE_NOTIFICATION ALARM_MANAGEMENT Sends a notification.
CREATE_ALARM_RULE ALARM_MANAGEMENT Creates an alert rule.
DELETE_ALARM_FILTER ALARM_MANAGEMENT Delete an alarm filter.
DELETE_ALARM_GROUP ALARM_MANAGEMENT Deletes an alarm group.
ADD_ALARM_GROUPS_ALARM_TYPES ALARM_MANAGEMENT Add multiple monitoring items to multiple alarm groups at a time.
DELETE_ALARM_RULE ALARM_MANAGEMENT Delete an alarm rule.
DELETE_ALARM_RULES ALARM_MANAGEMENT Batch delete an alarm rule.
RESOLVE_ALARM ALARM_MANAGEMENT Manually restore the alert.
CREATE_ALARM_TEMPLATE ALARM_MANAGEMENT Create an alarm template.
UPDATE_ALARM_TEMPLATE ALARM_MANAGEMENT Updates an alarm template.
DELETE_ALARM_TEMPLATE ALARM_MANAGEMENT Delete an alarm template.
SET_ALARM_TEMPLATE_TARGETS ALARM_MANAGEMENT Set the target of an alarm template.
SET_ALARM_TEMPLATE_STATUS ALARM_MANAGEMENT Set the status of an alarm template.
DOWNLOAD_ALARM_SNAPSHOT ALARM_MANAGEMENT Download an alarm event snapshot.
TEST_NOTIFICATION ALARM_MANAGEMENT Send a test notification.
UPDATE_ALARM_FILTER ALARM_MANAGEMENT Update alert filters.
UPDATE_ALARM_GROUP ALARM_MANAGEMENT Updates an alert group.
UPDATE_ALARM_RULE ALARM_MANAGEMENT Update an alarm rule.
CREATE_SUBSCRIPTION ALARM_MANAGEMENT Configures the subscription.
DELETE_SUBSCRIPTION ALARM_MANAGEMENT Deletes a subscription configuration.
UPDATE_SUBSCRIPTION ALARM_MANAGEMENT Update the subscription configuration.
DELETE_ALARM_GROUPS_ALARM_TYPES ALARM_MANAGEMENT Batch delete the alarms in the specified alarm group.
MODIFY_COMPACTION_SETTING OB_TENANT_MANAGEMENT Modify the minor compaction and major compaction settings of a tenant.
SUSPEND_TENANT_COMPACTION OB_TENANT_MANAGEMENT Suspend tenant compactions.
RESUME_TENANT_COMPACTION OB_TENANT_MANAGEMENT Continue major compaction for tenants.
CLEAR_COMPACTION_ERROR OB_TENANT_MANAGEMENT Clears the status of a failed compaction.
TRIGGER_TENANT_COMPACTION OB_TENANT_MANAGEMENT Trigger a tenant compaction task.
BATCH_SUSPEND_TENANT_COMPACTION OB_TENANT_MANAGEMENT Batch suspend major compaction.
BATCH_RESUME_TENANT_COMPACTION OB_TENANT_MANAGEMENT Batch resume tenant compaction.
BATCH_MODIFY_COMPACTION_SETTINGS OB_TENANT_MANAGEMENT Batch modify major compaction settings.
BATCH_TRIGGER_TENANT_COMPACTION OB_TENANT_MANAGEMENT Batch Trigger Tenant Compaction
BATCH_CLEAR_COMPACTION_ERROR OB_TENANT_MANAGEMENT Batch clear failed compactions.
ROLLBACK_MIGRATE_UNIT OB_CLUSTER_MANAGEMENT Rollback unit migration.
MIGRATE_UNIT OB_CLUSTER_MANAGEMENT Triggers unit migration.
TRY_DELETE_UNUSED_UNIT OB_CLUSTER_MANAGEMENT Attempts to delete unassociated resources.
COLLECT_OB_CLUSTER_COMPACTION_INFO OB_CLUSTER_MANAGEMENT Collects information about major compactions in the cluster.
TRIGGER_INSPECT INSPECTION_MANAGEMENT Trigger inspection.
MODIFY_INSPECTION_ITEM INSPECTION_MANAGEMENT Modify an inspection item.
MODIFY_INSPECTION_SCHEDULE_RULE INSPECTION_MANAGEMENT Modify inspection schedule rules.
SWITCH_INSPECTION_ITEM INSPECTION_MANAGEMENT Set the inspection switch.
DELETE_INSPECTION_REPORT INSPECTION_MANAGEMENT Delete inspection report.
REFRESH_POLICY OCP_USER_MANAGEMENT Refresh control policy
MODIFY_OB_CLUSTER_CONFIG_PARAMETERS_SWITCH OB_CLUSTER_MANAGEMENT Modify the type switch of the cluster configuration parameters.
BATCH_MODIFY_OCP_MONITOR_PASSWORD OB_TENANT_MANAGEMENT Change the passwords of ocp_monitor in all clusters.
TAG_RESOURCE_BY_KEY_VALUE TAG_MANAGEMENT The resources to which the tags are bound.
BATCH_CREATE_TAGS TAG_MANAGEMENT Create tags in batches.
UPDATE_TAG TAG_MANAGEMENT Modify the tag information.
DELETE_TAG TAG_MANAGEMENT Delete a specified tag.
TAG_RESOURCES TAG_MANAGEMENT Bind or unbind resources to tags.
CREATE_TAG TAG_MANAGEMENT Create a tag.
UPDATE_MONITOR_DASHBOARDS MONITOR_DASHBOARD_MANAGEMENT Updates a monitor dashboard.
DELETE_MONITOR_DASHBOARDS MONITOR_DASHBOARD_MANAGEMENT Delete a monitoring dashboard.
CREATE_MONITOR_DASHBOARDS MONITOR_DASHBOARD_MANAGEMENT Create Monitor Dashboard
MOVE_MONITOR_DASHBOARDS MONITOR_DASHBOARD_MANAGEMENT Move Monitor Dashboards
UPDATE_PROPERTY OCP_PROPERTY_MANAGEMENT Modify the configuration.
REFRESH_PROPERTIES OCP_PROPERTY_MANAGEMENT Refreshes all the configuration information.
CLOUD_CLOSE_TENANT_SESSION OB_TENANT_MANAGEMENT Close current sessions for tenants in multi-cloud mode.
CLOSE_TENANT_SESSION OB_TENANT_MANAGEMENT Close the current session, supports batch operation.
DISABLE_SESSION_TRACE_CONFIG OB_TENANT_MANAGEMENT Disable session-level end-to-end tracing.
SET_SESSION_TRACE_CONFIG OB_TENANT_MANAGEMENT Modify the end-to-end session trace configuration.
CLOSE_TENANT_QUERY OB_TENANT_MANAGEMENT Close the current query, which supports batch operations.
OPEN_LOG_BACKUP_PIECE_SWITCH BACKUP_RESTORE Specifies whether to switch log backup files.
DELETE_DATA_BACKUP BACKUP_RESTORE Deletes data backup files.
SET_BACKUP_DESTINATION BACKUP_RESTORE Sets the backup path for the cluster.
START_CLUSTER_RESTORE_PREVIEW BACKUP_RESTORE Initiates a cluster restore preview.
UPDATE_OB_CLUSTER_BACKUP_STRATEGY BACKUP_RESTORE Modifies the cluster backup strategy.
REMOVE_OB_CLUSTER_BACKUP_STRATEGY BACKUP_RESTORE Deletes a backup strategy for a cluster.
START_BACKUP_STRATEGY_SCHEDULE BACKUP_RESTORE Start the cluster backup schedule.
STOP_BACKUP_STRATEGY_SCHEDULE BACKUP_RESTORE Stops the backup scheduling of the cluster.
UPLOAD_PACKAGE SOFTWARE_PACKAGE_MANAGEMENT Upload software package.
CREATE_PACKAGE SOFTWARE_PACKAGE_MANAGEMENT Creates a software package.
CREATE_MONITOR_METRIC_ITEMS MONITOR_CUSTOMIZE_MANAGEMENT Create a monitoring metric item.
UPDATE_MONITOR_METRIC_ITEMS MONITOR_CUSTOMIZE_MANAGEMENT Modify the monitoring metric item.
DELETE_MONITOR_METRIC_ITEMS MONITOR_CUSTOMIZE_MANAGEMENT Delete a monitoring metric.
CREATE_MONITOR_COLLECT_ITEMS MONITOR_CUSTOMIZE_MANAGEMENT Creates an SQL-type monitored item.
DELETE_MONITOR_COLLECT_ITEMS MONITOR_CUSTOMIZE_MANAGEMENT Delete a monitor collection item.
CREATE_MONITOR_VISUALIZATIONS MONITOR_CUSTOMIZE_MANAGEMENT Create monitoring charts.
UPDATE_MONITOR_VISUALIZATIONS MONITOR_CUSTOMIZE_MANAGEMENT Update a monitor visualization.
DELETE_MONITOR_VISUALIZATIONS MONITOR_CUSTOMIZE_MANAGEMENT Delete monitoring chart.
MODIFY_CLUSTER_RESOURCE_SETTINGS OB_CLUSTER_MANAGEMENT Modify cluster resource management parameters.
STOP_HOST_AGENT_PROCESS COMPUTE_HOST_MANAGEMENT Stops an agent process.
RESTART_HOST_AGENT_PROCESS COMPUTE_HOST_MANAGEMENT Restart the host agent process.
DELETE_LB_INSTANCE OB_PROXY_CLUSTER_MANAGEMENT Delete an LB instance.
ADD_LB_INSTANCE OB_PROXY_CLUSTER_MANAGEMENT Add an LB instance.
BATCH_SWITCH_OBPROXY_BIND_CORE_STATE OB_PROXY_CLUSTER_MANAGEMENT Enables you to batch enable or disable the binding of OBProxy nodes to their associated Kubernetes clusters.
TAG_OBPROXY OB_PROXY_CLUSTER_MANAGEMENT Bind/Unbind OBProxy Tag.
UPDATE_LB_SERVICE OB_PROXY_CLUSTER_MANAGEMENT Modify the LB service.
EXPORT_LB_INSTANCE_CONFIG OB_PROXY_CLUSTER_MANAGEMENT Export the information of the lb instance of the cluster.
ADD_LB_SERVICE OB_PROXY_CLUSTER_MANAGEMENT Adds an LB service.
UPDATE_LB_INSTANCE OB_PROXY_CLUSTER_MANAGEMENT Modify the LB instance.
DELETE_OBPROXY_SERVER OB_PROXY_CLUSTER_MANAGEMENT Deletes an OBProxy server.
UPGRADE_OBPROXY_SERVER OB_PROXY_CLUSTER_MANAGEMENT Upgrade OBProxy Server.
BATCH_DELETE_OB_LINK OB_PROXY_CLUSTER_MANAGEMENT Delete associations between an OceanBase cluster and multiple OBProxies.
ONLINE_OBPROXY_SERVERS OB_PROXY_CLUSTER_MANAGEMENT Start OBProxy server.
START_OBPROXY_SERVER OB_PROXY_CLUSTER_MANAGEMENT Start the OBProxy server.
OFFLINE_OBPROXY_SERVERS OB_PROXY_CLUSTER_MANAGEMENT Offline OBProxy server.
RESTART_OBPROXY_SERVER OB_PROXY_CLUSTER_MANAGEMENT Restart the OBProxy server.
ONLINE_OBPROXIES OB_PROXY_CLUSTER_MANAGEMENT Online OBProxies.
OFFLINE_OBPROXIES OB_PROXY_CLUSTER_MANAGEMENT Offline OBProxy.
STOP_OBPROXY_SERVER OB_PROXY_CLUSTER_MANAGEMENT Stops the OBProxy server.
DELETE_OBPROXY_CLUSTER_PARAMETERS OB_PROXY_CLUSTER_MANAGEMENT Delete OBProxy cluster parameters.
REFRESH_OBPROXY_SERVER_PARAMETERS OB_PROXY_CLUSTER_MANAGEMENT Refreshes the OBProxy server parameters.
REFRESH_OBPROXIES_PARAMETERS OB_PROXY_CLUSTER_MANAGEMENT Refreshes the parameters of OBProxy.
PARSE_LB_INSTANCE_CONFIG_FILE OB_PROXY_CLUSTER_MANAGEMENT Parses a file to obtain the information about LB instances.
CREATE_OBPROXY_LOAD_BALANCE_APP OB_PROXY_CLUSTER_MANAGEMENT Specifies the load balancing application configuration of an OBProxy cluster.
UPDATE_OBPROXY_LOAD_BALANCE_APP OB_PROXY_CLUSTER_MANAGEMENT Modifies the load balancing application configuration for the OBProxy cluster.
DELETE_OBPROXY_LOAD_BALANCE_APP OB_PROXY_CLUSTER_MANAGEMENT Deletes the load balancing application configuration of an OBProxy cluster.
CREATE_OB_PROXY_CPU_CORE_BIND_CONFIG OB_PROXY_CLUSTER_MANAGEMENT Add OBProxy core bind configurations.
MODIFY_OB_PROXY_CPU_CORE_BIND_CONFIG OB_PROXY_CLUSTER_MANAGEMENT Modify the CPU core bind configuration of an OBProxy.
UPDATE_ALARM_CHANNEL ALARM_MANAGEMENT Update the channel.
DELETE_ALARM_CHANNEL ALARM_MANAGEMENT Deletes an alarm channel.
CREATE_ALARM_CHANNEL ALARM_MANAGEMENT Create an alert channel.
REINSTALL_OB_SERVER OB_CLUSTER_MANAGEMENT Reinstall the OBServer.
DISABLE_TRACE_CONFIG OB_TENANT_MANAGEMENT Disable end-to-end trace configuration.
SET_TRACE_CONFIG OB_TENANT_MANAGEMENT Modifies end-to-end tracing configuration.
TAG_OB_TENANT OB_TENANT_MANAGEMENT Bind/Unbind Tenant Tag
DELETE_UNIT_GROUP OB_TENANT_MANAGEMENT Delete a specified unit group.
MODIFY_TENANT_DESCRIPTION OB_TENANT_MANAGEMENT Modify tenant notes.
IMPORT_OB_CLUSTER OB_CLUSTER_MANAGEMENT Import a cluster.
MARK_META_CLUSTER OB_CLUSTER_MANAGEMENT Specify the meta cluster.
SYNC_CLUSTER OB_CLUSTER_MANAGEMENT Synchronize cluster information.
BATCH_SWITCH_OB_BIND_CORE_STATE OB_CLUSTER_MANAGEMENT Batch enable/disable OceanBase bind core.
TAG_OB_CLUSTER OB_CLUSTER_MANAGEMENT Bind/Unbind Cluster Tag.
CREATE_OB_CPU_CORE_BIND_CONFIG OB_CLUSTER_MANAGEMENT Add an OceanBase bind core configuration.
MODIFY_OB_CPU_CORE_BIND_CONFIG OB_CLUSTER_MANAGEMENT Modify the OceanBase bind core configuration.
CREATE_CONSUMER_GROUP OB_TENANT_MANAGEMENT Creates a resource group.
DISABLE_RESOURCE_PLAN OB_TENANT_MANAGEMENT Disables the resource management plan.
ENABLE_RESOURCE_PLAN OB_TENANT_MANAGEMENT Enables resource management plans.
MODIFY_CONSUMER_GROUP OB_TENANT_MANAGEMENT Modify a resource group.
MODIFY_RESOURCE_PLAN OB_TENANT_MANAGEMENT Modify the resource management plan.
CREATE_RESOURCE_PLAN OB_TENANT_MANAGEMENT Create a resource management plan.
DELETE_RESOURCE_PLAN OB_TENANT_MANAGEMENT Deletes a resource management plan.
DELETE_CONSUMER_GROUP OB_TENANT_MANAGEMENT Deletes a consumer group.
STOP_BACKUP_RESTORE_SERVICE BACKUP_RESTORE Stop a service on a server.
PARSE_OB_BACKUP_INFO BACKUP_RESTORE Parses global backup information.
CLEAR_RESTORE_SOURCE BACKUP_RESTORE The path for data unloader.
ADD_BACKUP_RESTORE_MACHINES BACKUP_RESTORE To add a backup restore service.
ADD_RESTORE_SOURCE BACKUP_RESTORE Specifies the path to restore the data.
CANCEL_RESTORE_TASK BACKUP_RESTORE Cancel a restore task.
START_RESTORE_PREVIEW BACKUP_RESTORE Initiate restore preview.
UPDATE_SAMPLING_INSPECT_STRATEGY BACKUP_RESTORE Modify the sampling inspection strategy.
REMOVE_SAMPLING_INSPECT_STRATEGY BACKUP_RESTORE Deletes a sampling inspection strategy.
START_SAMPLING_INSPECT_STRATEGY BACKUP_RESTORE Starts a sampling inspection strategy.
STOP_SAMPLING_INSPECT_STRATEGY BACKUP_RESTORE Stop inspection sampling strategy.
INSTALL_BACKUP_RESTORE_SERVICE BACKUP_RESTORE Install component service.
UPGRADE_BACKUP_RESTORE_SERVICE BACKUP_RESTORE Upgrades the service version.
UPDATE_BACKUP_RESTORE_SERVICE_CONFIG BACKUP_RESTORE Update service configuration.
DELETE_BACKUP_RESTORE_SERVICE BACKUP_RESTORE Delete Backup Restore Service.
START_BACKUP_RESTORE_SERVICE BACKUP_RESTORE Start a service on a server.
UNINSTALL_BACKUP_RESTORE_SERVICE BACKUP_RESTORE Uninstall the service on the specified machine.
RESTART_BACKUP_RESTORE_SERVICE BACKUP_RESTORE Restart the service.
CREATE_TENANT_PARAMETER_TEMPLATE OB_TENANT_MANAGEMENT Creates a tenant parameter template.
UPDATE_TENANT_PARAMETER_TEMPLATE OB_TENANT_MANAGEMENT Modifies the tenant parameter template.
DELETE_TENANT_PARAMETER_TEMPLATE OB_TENANT_MANAGEMENT Delete a tenant parameter template.
EXPORT_TENANT_PARAMETER_TEMPLATE OB_TENANT_MANAGEMENT Allows you to export a tenant parameter template.
PARSE_TENANT_PARAMETER_TEMPLATE_FILE OB_TENANT_MANAGEMENT Parses the tenant parameter template YAML file.
LOCK_USER OCP_USER_MANAGEMENT Locks a specified user account.
DELETE_ACCESS_KEY OCP_USER_MANAGEMENT Delete an AccessKey.
CREATE_ACCESS_KEY OCP_USER_MANAGEMENT Create AccessKey.
ENABLE_ACCESS_KEY OCP_USER_MANAGEMENT Enable AccessKey.
DISABLE_ACCESS_KEY OCP_USER_MANAGEMENT Disables an AccessKey.
DELETE_LOGIN_RECORD OCP_USER_MANAGEMENT Delete user login information.
UN_LOCK_USER OCP_USER_MANAGEMENT Unlock a specified user account.
CREATE_ALARM_METRIC_META ALARM_MANAGEMENT Creates an alert metric rule.
START_DIAGNOSIS SQL_PERF_MANAGEMENT Initiates a diagnostic task.
BATCH_CLOSE_TRANSACTION SQL_PERF_MANAGEMENT Batch close transactions.
BATCH_DROP_SQL_OUTLINE SQL_PERF_MANAGEMENT Batch drop outline.
CREATE_OUTLINE SQL_PERF_MANAGEMENT Binds an Outline to an SQL statement.
BATCH_CREATE_OUTLINE SQL_PERF_MANAGEMENT Bind Outline to SQL
DELETE_OUTLINE SQL_PERF_MANAGEMENT Deletes the outline of the specified SQL query.
GENERATE_ASH_REPORT_V2 SQL_PERF_MANAGEMENT Generate an ASH performance report.
GENERATE_ASH_REPORT SQL_PERF_MANAGEMENT Generate an ASH performance report.
GENERATE_WORKLOAD_REPORT SQL_PERF_MANAGEMENT Generate workload report.
GENERATE_SNAPSHOT SQL_PERF_MANAGEMENT Generate a snapshot.
MC_CREATE_OUTLINE SQL_PERF_MANAGEMENT SQL Bind Outline (MultiCloud)
DROP_OUTLINE SQL_PERF_MANAGEMENT Drops the outline.
CREATE_CLUSTER_PARAMETER_TEMPLATE OB_CLUSTER_MANAGEMENT Creates a cluster parameter template.
UPDATE_CLUSTER_PARAMETER_TEMPLATE OB_CLUSTER_MANAGEMENT Modify a cluster parameter template.
DELETE_CLUSTER_PARAMETER_TEMPLATE OB_CLUSTER_MANAGEMENT Deletes a cluster parameter template.
EXPORT_CLUSTER_PARAMETER_TEMPLATE OB_CLUSTER_MANAGEMENT Export Cluster Parameter Template.
PARSE_CLUSTER_PARAMETER_TEMPLATE_FILE OB_CLUSTER_MANAGEMENT Parses a YAML file that contains a cluster parameter template.
STOP_HOST COMPUTE_HOST_MANAGEMENT Stop Host
CREATE_REGION COMPUTE_HOST_MANAGEMENT Add Region.
TAG_COMPUTE_HOST COMPUTE_HOST_MANAGEMENT Bind/Unbind Host Tag.
IGNORE_SYSTEM_INFO_CHECK COMPUTE_HOST_MANAGEMENT Ignore check installation.
CREATE_VPC COMPUTE_HOST_MANAGEMENT Add a new VPC.
UPDATE_VPC COMPUTE_HOST_MANAGEMENT Updates the VPC information.
REPAIR_SYSTEM_INFO COMPUTE_HOST_MANAGEMENT Repairs the installation status of the remote host.
AUTO_RE_INSTALL_HOST_AGENT COMPUTE_HOST_MANAGEMENT Upgrade the host agent to the latest version.
CHECK_AND_REPAIR_SYSTEM_INFO COMPUTE_HOST_MANAGEMENT Check and repair the installed software.
DELETE_VPC_BY_ID COMPUTE_HOST_MANAGEMENT Deletes the specified VPC by ID.
START_HOST COMPUTE_HOST_MANAGEMENT Start the host.
DELETE_HOST_TYPE COMPUTE_HOST_MANAGEMENT Delete a host type.
DELETE_REGION COMPUTE_HOST_MANAGEMENT Delete a region.
DELETE_IDC COMPUTE_HOST_MANAGEMENT Delete an IDC.
CREATE_IDC COMPUTE_HOST_MANAGEMENT Add an IDC.
CREATE_HOST_TYPE COMPUTE_HOST_MANAGEMENT Adds a host type.
IMPORT_HOST COMPUTE_HOST_MANAGEMENT Import a new host.
CREATE_UNIT_SPEC OB_CLUSTER_MANAGEMENT Specifies the specifications for creating a resource unit.
MODIFY_UNIT_SPEC OB_CLUSTER_MANAGEMENT Modifies the specifications of a resource unit.
DELETE_UNIT_SPEC OB_CLUSTER_MANAGEMENT Deletes a unit specification.
ADD_MONITOR_TARGET COMPUTE_HOST_MANAGEMENT Add a monitored object to the host.
REMOVE_MONITOR_TARGET COMPUTE_HOST_MANAGEMENT Removes a monitoring target from the host.
DISABLE_AUTO_STATS_GATHER OB_TENANT_MANAGEMENT Disables auto-statistics collection.
ENABLE_AUTO_STATS_GATHER OB_TENANT_MANAGEMENT Specifies whether automatic statistics collection is enabled.
LOCK_STATS_GATHER OB_TENANT_MANAGEMENT Collects statistics about locks.
UPDATE_STATS_GATHER_PREFS OB_TENANT_MANAGEMENT Set statistics preferences.
UNLOCK_STATS_GATHER OB_TENANT_MANAGEMENT Unlock statistics collection.
START_MANUAL_STATS_GATHER_TASK OB_TENANT_MANAGEMENT Initiate a manual statistics collection task.
UPDATE_AUTO_STATS_GATHER_ATTRIBUTES OB_TENANT_MANAGEMENT Modify the configuration of an automatic statistics information collection task.
CANCEL_AUTO_STATS_GATHER_ATTRIBUTES OB_TENANT_MANAGEMENT Cancel an automatic statistics task. This API is available only in OceanBase Database V4.2.2 and later.
BACKUP_NOW BACKUP_RESTORE Initiate tenant data backup.
CREATE_OB_TENANT_BACKUP_STRATEGY BACKUP_RESTORE Create a tenant backup strategy.
UPDATE_OB_TENANT_BACKUP_STRATEGY BACKUP_RESTORE Update tenant backup strategy.
DELETE_OB_TENANT_BACKUP_STRATEGY BACKUP_RESTORE Delete tenant backup strategy.
START_TENANT_BACKUP_STRATEGY_SCHEDULE BACKUP_RESTORE Start Tenant Backup Scheduling
STOP_TENANT_BACKUP_STRATEGY_SCHEDULE BACKUP_RESTORE Stop tenant backup schedule.
RESTART_BINLOG_CLUSTER BINLOG_SERVICE_MANAGEMENT Restart Binlog cluster.
STOP_BINLOG_CLUSTER BINLOG_SERVICE_MANAGEMENT Stop the Binlog cluster.
DELETE_BINLOG_CLUSTER BINLOG_SERVICE_MANAGEMENT Delete a Binlog cluster.
DELETE_BINLOG_SERVER BINLOG_SERVICE_MANAGEMENT Delete a Binlog Server.
CREATE_BINLOG_CLUSTER BINLOG_SERVICE_MANAGEMENT Create a Binlog cluster.
RESTART_BINLOG_INSTANCE BINLOG_SERVICE_MANAGEMENT Restart a Binlog Instance.
START_BINLOG_CLUSTER BINLOG_SERVICE_MANAGEMENT Start Binlog Cluster.
STOP_BINLOG_SERVER BINLOG_SERVICE_MANAGEMENT Stop the Binlog server.
ADD_BINLOG_SERVER BINLOG_SERVICE_MANAGEMENT Add a Binlog Server.
START_BINLOG_SERVER BINLOG_SERVICE_MANAGEMENT Start the Binlog Server.
STOP_BINLOG_INSTANCE BINLOG_SERVICE_MANAGEMENT Stop a Binlog instance.
START_BINLOG_INSTANCE BINLOG_SERVICE_MANAGEMENT Start the Binlog instance.
DELETE_BINLOG_INSTANCE BINLOG_SERVICE_MANAGEMENT Delete a Binlog instance.
ADD_BINLOG_INSTANCES BINLOG_SERVICE_MANAGEMENT Add Binlog Instance Replicas
SWITCH_MASTER_BINLOG_INSTANCE BINLOG_SERVICE_MANAGEMENT Switches the primary BINLOG instance.
DELETE_BINLOG_INSTANCE_DUMP BINLOG_SERVICE_MANAGEMENT Disconnect the Binlog instance subscription.
CONFIGURE_BINLOG_INSTANCE_THROTTLE BINLOG_SERVICE_MANAGEMENT Configure throttling for Binlog instances.
MODIFY_BINLOG_INSTANCE_PARAMETER BINLOG_SERVICE_MANAGEMENT Modify a Binlog instance parameter.
MODIFY_BINLOG_CLUSTER_PARAMETER BINLOG_SERVICE_MANAGEMENT Modify a binlog cluster parameter.
UPGRADE_BINLOG_CLUSTER BINLOG_SERVICE_MANAGEMENT Upgrade a Binlog cluster.
ACTIVATE_TENANT_BINLOG_SERVICE OB_TENANT_MANAGEMENT Enable tenant binlog service.
DEACTIVATE_TENANT_BINLOG_SERVICE OB_TENANT_MANAGEMENT Deactivates the Binlog service for a tenant.
MODIFY_TENANT_BINLOG_SERVICE OB_TENANT_MANAGEMENT Modify Binlog service for the tenant.
IMPORT_DASHBOARD_JSON MONITOR_DASHBOARD_MANAGEMENT Import monitoring dashboard.
ADD_USER ORGANIZATION_MANAGEMENT Add User.
ADD_RESOURCES ORGANIZATION_MANAGEMENT Batch add organization resources.
UPDATE_ORGANIZATION ORGANIZATION_MANAGEMENT Modify organization information.
DELETE_USER_BY_EXTERNAL_ID ORGANIZATION_MANAGEMENT Removes a user from the organization.
ADD_RESOURCES_BY_EXTERNAL_ID ORGANIZATION_MANAGEMENT Batch add organization resources.
REMOVE_USER ORGANIZATION_MANAGEMENT Remove a user from an organization.
ADD_USER_BY_EXTERNAL_ID ORGANIZATION_MANAGEMENT Add user.
DELETE_ORGANIZATION ORGANIZATION_MANAGEMENT Delete an organization.
REMOVE_RESOURCES ORGANIZATION_MANAGEMENT Removes the specified type of resources.
CREATE_ORGANIZATIONS ORGANIZATION_MANAGEMENT Create organizations in batches.
REMOVE_RESOURCES_BY_EXTERNAL_ID ORGANIZATION_MANAGEMENT Removes the specified resources of the specified type.
DELETE_ORGANIZATION_BY_EXTERNAL_ID ORGANIZATION_MANAGEMENT Delete an organization.
UPDATE_ORGANIZATION_BY_EXTERNAL_ID ORGANIZATION_MANAGEMENT Modify organization information.
SHARE_RESOURCES ORGANIZATION_MANAGEMENT Share organization resources.
CREATE_BINLOG_CLUSTER_PARAMETER_TEMPLATE BINLOG_SERVICE_MANAGEMENT Create a binlog cluster parameter template.
UPDATE_BINLOG_CLUSTER_PARAMETER_TEMPLATE BINLOG_SERVICE_MANAGEMENT Modifies a Binlog cluster parameter template.
DELETE_BINLOG_CLUSTER_PARAMETER_TEMPLATE BINLOG_SERVICE_MANAGEMENT Deletes a Binlog cluster parameter template.
EXPORT_BINLOG_CLUSTER_PARAMETER_TEMPLATE BINLOG_SERVICE_MANAGEMENT Exports the Binlog cluster parameter template.
PARSE_BINLOG_CLUSTER_PARAMETER_TEMPLATE_FILE BINLOG_SERVICE_MANAGEMENT Parses the YAML file of the cluster parameter template for Binlogs.
CREATE_OBPROXY_PARAMETER_TEMPLATE OB_PROXY_CLUSTER_MANAGEMENT Creates an OBProxy cluster parameter template.
UPDATE_OBPROXY_PARAMETER_TEMPLATE OB_PROXY_CLUSTER_MANAGEMENT Modifies a parameter template for an OBProxy cluster.
DELETE_OBPROXY_PARAMETER_TEMPLATE OB_PROXY_CLUSTER_MANAGEMENT Delete OBProxy cluster parameter templates.
EXPORT_OBPROXY_PARAMETER_TEMPLATE OB_PROXY_CLUSTER_MANAGEMENT Export the OBProxy cluster parameter template.
PARSE_OBPROXY_PARAMETER_TEMPLATE_FILE OB_PROXY_CLUSTER_MANAGEMENT Parses the Yaml file of the OBProxy cluster parameter template.
UPDATE_AGENT_RESOURCE_CONFIG COMPUTE_HOST_MANAGEMENT Modify parameters of resource configuration for the host Agent.
UPDATE_OB_CLUSTER_AGENT_RESOURCE_CONFIG OB_CLUSTER_MANAGEMENT Modify the Agent resource configuration parameters of the OceanBase cluster.
BATCH_REMOVE_ARBITRATION OB_CLUSTER_MANAGEMENT Batch remove arbitration service.
BATCH_REPLACE_ARBITRATION OB_CLUSTER_MANAGEMENT Batch replace arbitration service.
REMOVE_ARBITRATION_ASYNC OB_CLUSTER_MANAGEMENT Asynchronously remove the arbitration service.
BATCH_ADD_ARBITRATION OB_CLUSTER_MANAGEMENT Add an arbitration service to the cluster.
ADD_ARBITRATION_ASYNC OB_CLUSTER_MANAGEMENT Asynchronously add an arbitration service.
CREATE_TABLESPACE OB_TENANT_MANAGEMENT Creates a tablespace.
ENABLE_TDE OB_TENANT_MANAGEMENT Enables tenant TDE.
BATCH_LOCK_DB_USER OB_TENANT_MANAGEMENT Batch lock a database user.
BATCH_UN_LOCK_DB_USER OB_TENANT_MANAGEMENT Batch Unlock Database User.
CREATE_REPORT OB_CLUSTER_MANAGEMENT Create a report.
DELETE_REPORT OB_CLUSTER_MANAGEMENT Delete report.
DOWNLOAD_REPORT OB_CLUSTER_MANAGEMENT Download report.
CREATE_CERTIFICATE_GROUP CERTIFICATE_MANAGEMENT Creates a certificate group.
DELETE_CERTIFICATE_GROUP CERTIFICATE_MANAGEMENT Deletes a certificate group.
ENABLE_OBPROXY_SSL OB_PROXY_CLUSTER_MANAGEMENT Enables SSL authentication for the OBProxy cluster.
UPDATE_OBPROXY_SSL_CERTIFICATES OB_PROXY_CLUSTER_MANAGEMENT Update the SSL certificate of OBProxy clusters.
DISABLE_OBPROXY_SSL OB_PROXY_CLUSTER_MANAGEMENT Disables the SSL verification for OBProxy clusters.
ENABLE_OB__SSL OB_CLUSTER_MANAGEMENT Enables SSL authentication for the OceanBase cluster.
UPDATE_OB_SSL_CERTIFICATES OB_CLUSTER_MANAGEMENT Updates OceanBase Cluster SSL Certificates.
DISABLE_OB_SSL OB_CLUSTER_MANAGEMENT Disable OceanBase cluster SSL authentication.
UPDATE_REGION COMPUTE_HOST_MANAGEMENT Modify the region.
UPDATE_IDC COMPUTE_HOST_MANAGEMENT Update IDC.
UPDATE_HOST_TYPE COMPUTE_HOST_MANAGEMENT Update the host type.
GRANT_ROLE_TO_USER OB_TENANT_MANAGEMENT Grant a role to a user.
REVOKE_ROLE_FROM_USER OB_TENANT_MANAGEMENT Revoke a role from a user.
MODIFY_ROLE_FROM_USER OB_TENANT_MANAGEMENT Modify a user role.
CREATE_DATABASE_ROLE OB_TENANT_MANAGEMENT Create a database role.
DELETE_DATABASE_ROLE OB_TENANT_MANAGEMENT Deletes a database role.
GRANT_GLOBAL_PRIVILEGE_TO_ROLE OB_TENANT_MANAGEMENT Grants global privileges to a role.
REVOKE_GLOBAL_PRIVILEGE_FROM_ROLE OB_TENANT_MANAGEMENT Revokes a global privilege from a role.
MODIFY_GLOBAL_PRIVILEGE_FROM_ROLE OB_TENANT_MANAGEMENT Modifies the global privileges of a role.
GRANT_ROLE_TO_ROLE OB_TENANT_MANAGEMENT Grants a role to another role.
REVOKE_ROLE_FROM_ROLE OB_TENANT_MANAGEMENT Revoke a role from a role.
MODIFY_ROLE_FROM_ORACLE_ROLE OB_TENANT_MANAGEMENT Modifies an Oracle role.
REGISTER_FOLLOWER_OCP_CLUSTER OCP_CLUSTER_MANAGEMENT Register a follower OCP cluster.
DELETE_MC_OCP_CLUSTER OCP_CLUSTER_MANAGEMENT Delete an OCP cluster.
LEAVE_FOLLOWER_OCP_CLUSTER OCP_CLUSTER_MANAGEMENT Disassociate the OCP Cluster.
FAILOVER_MC_OCP_CLUSTER OCP_CLUSTER_MANAGEMENT OCP cluster disaster recovery.
SWITCHOVER_MC_OCP_CLUSTER OCP_CLUSTER_MANAGEMENT Daily switching for OCP clusters
CREATE_ARBITRATION_SERVICE ARBITRATION_SERVICE_MANAGEMENT Creates an arbitration service.
STOP_ARBITRATION_SERVICE ARBITRATION_SERVICE_MANAGEMENT Stop the arbitration service.
START_ARBITRATION_SERVICE ARBITRATION_SERVICE_MANAGEMENT Starts the arbitration service.
RESTART_ARBITRATION_SERVICE ARBITRATION_SERVICE_MANAGEMENT Restart the arbitration service.
UPGRADE_ARBITRATION_SERVICE ARBITRATION_SERVICE_MANAGEMENT Upgrade the arbitration service.
DELETE_ARBITRATION_SERVICE ARBITRATION_SERVICE_MANAGEMENT Delete an arbitration service.
TAKEOVER_ARBITRATION_SERVICE ARBITRATION_SERVICE_MANAGEMENT Take over an arbitration service.
MOVE_OUT_ARBITRATION_SERVICE ARBITRATION_SERVICE_MANAGEMENT Move out an arbitration service.
TAG_ARBITRATION_SERVICE ARBITRATION_SERVICE_MANAGEMENT Binds/Unbinds a Tag to an Arbitration Service.
UPDATE_OCP_CLUSTER_CONFIG OCP_CLUSTER_MANAGEMENT Update OCP cluster configuration.
REVOKE_ROLE_FROM_ORACLE_USER OB_TENANT_MANAGEMENT Revoke a role from an Oracle user.
GRANT_ROLE_TO_ORACLE_USER OB_TENANT_MANAGEMENT Grants a role to an Oracle user.
MODIFY_ROLE_FROM_ROLE OB_TENANT_MANAGEMENT Modify the role.
REVOKE_ROLE_FROM_ORACLE_ROLE OB_TENANT_MANAGEMENT Revoke a role from an Oracle role.
MODIFY_ORACLE_ROLE_FROM_USER OB_TENANT_MANAGEMENT Modify the role of an Oracle user.
GRANT_ORACLE_ROLE_TO_ROLE OB_TENANT_MANAGEMENT Grants an Oracle role to a role.
DELETE_DB_ROLE OB_TENANT_MANAGEMENT Deletes a database role.
CREATE_DB_ROLE OB_TENANT_MANAGEMENT Creates a database role.
GRANT_GLOBAL_PRIVILEGE_TO_ORACLE_ROLE OB_TENANT_MANAGEMENT Grants system privileges on an Oracle role.
REVOKE_GLOBAL_PRIVILEGE_FROM_ORACLE_ROLE OB_TENANT_MANAGEMENT Revoke global privileges from an Oracle role.
MODIFY_GLOBAL_PRIVILEGE_FROM_ORACLE_ROLE OB_TENANT_MANAGEMENT Modify system privileges of an Oracle role.
UPDATE_ORACLE_AUDIT_CONFIG OB_TENANT_MANAGEMENT Update an Oracle audit configuration.
ENABLE_ORACLE_AUDIT OB_TENANT_MANAGEMENT Enable Oracle audit.
DISABLE_ORACLE_AUDIT OB_TENANT_MANAGEMENT Disable Oracle audit.
CREATE_CONTINGENCY_PLAN CONTINGENCY_MANAGEMENT Create a contingency plan.
CONFIRM_CONTINGENCY_PLAN CONTINGENCY_MANAGEMENT Verify the contingency plan.
RETRY_CONTINGENCY_PLAN CONTINGENCY_MANAGEMENT The plan that is used to handle failures and take over when a failover happens.
DELETE_CONTINGENCY_PLAN_CONFIG CONTINGENCY_MANAGEMENT Deletes a contingency plan configuration.
ENABLE_CONTINGENCY_PLAN_CONFIG CONTINGENCY_MANAGEMENT Enable the contingency plan configuration.
RUN_CONTINGENCY_OPERATION CONTINGENCY_MANAGEMENT Execute contingency operations.
SAVE_PLAN_CONFIGS CONTINGENCY_MANAGEMENT Save plan configurations.
DOWNLOAD_COLLECTIONS_REPORT COLLECTIONS_MANAGEMENT Download an information collection report.
CANCEL_COLLECTION COLLECTIONS_MANAGEMENT Cancel information collection.
SET_COLLECTION_SOURCE_STATUS COLLECTIONS_MANAGEMENT Set the switch for the event source.
DOWNLOAD_COLLECTION_REPORT_FILE COLLECTIONS_MANAGEMENT Download a collection report file.
CREATE_COLLECTION COLLECTIONS_MANAGEMENT Create information collection.
CREATE_ARBITRATION_SERVICE_GROUP ARBITRATION_SERVICE_GROUP_MANAGEMENT Creates an arbitration service group.
MODIFY_ARBITRATION_SERVICE_GROUP ARBITRATION_SERVICE_GROUP_MANAGEMENT Update an arbitration service group.
DELETE_ARBITRATION_SERVICE_GROUP ARBITRATION_SERVICE_GROUP_MANAGEMENT Deletes an arbitration service group.
UPGRADE_ARBITRATION_SERVICE_GROUP ARBITRATION_SERVICE_GROUP_MANAGEMENT Upgrade arbitration service group.
DELETE_LARGE_MODEL AI_ASSISTANT_MODEL_MANAGEMENT Delete a model.
SET_SYSTEM_MODELS AI_ASSISTANT_MODEL_MANAGEMENT Set system models.
MODIFY_LARGE_MODEL_PROVIDER AI_ASSISTANT_MODEL_MANAGEMENT Modify the model vendor.
CREATE_LARGE_MODEL AI_ASSISTANT_MODEL_MANAGEMENT Add Model.

Returned result

Parameter Type Description
data Object The requested data.
├─ contents Array For more information, see the data structure of AuditEventHistory.
├─ page Object For more information, see page parameter details.
successful Boolean Indicates whether the request is successful.
timestamp Datetime The timestamp when the server finishes the request.
duration Integer The time taken by the server to process the request, in milliseconds.
status Integer An HTTP status code that conforms to the HTTP status code standard.
traceId String The Trace ID of the request, which is used to troubleshoot issues.
server String The address of the application service that responds to the request.

Data structure of AuditEventHistory

Parameter Type Description
id Long The ID of the history event.
operationEvent String The operation type. For more information, see the Operation Events section in the preceding table.
eventType String The event type. For more information, see the Event Type section in the preceding table.
resourceType String The resource type. Valid values: COMPUTE_HOST (host), OB_TENANT (tenant), OB_CLUSTER (OceanBase cluster), OB_PROXY_CLUSTER (OBProxy cluster), OCP_USER (OCP user), OCP_ROLE (OCP role), and OCP_CLUSTER (OCP cluster).
resourceId Long The ID of the resource, such as the host ID, OceanBase cluster ID, OBProxy ID, and tenant ID.
resourceName String The name of the resource, such as the OceanBase cluster name, host IP address, and tenant name.
parentResource String The name of the parent resource. If a parent resource exists, this field indicates the name of the parent resource. Example: The parent resource of a tenant is the cluster. When resourceName indicates the name of the tenant, parentResource indicates the name of the cluster.
operatorName String The name of the operator, that is, the OCP username.
operatorId Long The ID of the operator, that is, the OCP user ID.
status String The event status. Valid values: SUCCESS and FAILED.
taskId Long The task ID. If the event is an O&M task, this field indicates the ID of the O&M task.
executionType String The execution type of the O&M task. Valid values: NEW (new task) and RETRY (retry task).
eventInfo String The request parameters when the operation is performed.
clientIp String The IP address of the client that performs the operation.
startTime OffsetDateTime The start time of the operation.
endTime OffsetDateTime The end time of the operation.

Page parameter details

Parameter Type Description
totalElements Integer The total number of records.
totalPages Integer The total number of pages.
number Integer The current page number.
size Integer The size of the current page.

Example

Request example

GET /api/v2/audit/events

Response example

{
    "data": {
        "contents": [
            {
                "clientIp": "xxx.xxx.xxx.1",
                "endTime": "2025-04-29T16:00:00+08:00",
                "eventInfo": "{\"param\":{\"encryptionAlgorithm\":\"aes-128\",\"name\":\"test02\"},\"tenantId\":6000016,\"id\":6000008}",
                "eventType": "OB_TENANT_MANAGEMENT",
                "executionType": "NEW",
                "id": 8000318,
                "methodSignature": "com.oceanbase.ocp.server.common.controller.TdeController.createTablespace",
                "operationEvent": "CREATE_TABLESPACE",
                "operatorId": 3001017,
                "operatorName": "docs",
                "requestUrl": "http://xxx.xxx.xxx.2:10550/api/v2/ob/clusters/6000008/tenants/6000016/tablespace",
                "resourceType": "OB_TENANT",
                "resources": [
                    {
                        "id": 8000318,
                        "parentResource": "ob4252:1658110578",
                        "resourceId": 6000016,
                        "resourceName": "oracle_tenant"
                    }
                ],
                "serverIp": "xxx.xxx.xxx.2",
                "startTime": "2025-04-29T16:00:00+08:00",
                "status": "SUCCESS"
            },
            {
                "clientIp": "xxx.xxx.xxx.1",
                "endTime": "2025-04-29T15:43:39+08:00",
                "eventInfo": "{\"param\":{\"encryptionAlgorithm\":\"aes-256\",\"name\":\"test01\"},\"tenantId\":6000016,\"id\":6000008}",
                "eventType": "OB_TENANT_MANAGEMENT",
                "executionType": "NEW",
                "id": 8000317,
                "methodSignature": "com.oceanbase.ocp.server.common.controller.TdeController.createTablespace",
                "operationEvent": "CREATE_TABLESPACE",
                "operatorId": 3001017,
                "operatorName": "docs",
                "requestUrl": "http://xxx.xxx.xxx.2:10550/api/v2/ob/clusters/6000008/tenants/6000016/tablespace",
                "resourceType": "OB_TENANT",
                "resources": [
                    {
                        "id": 8000317,
                        "parentResource": "ob4252:1658110578",
                        "resourceId": 6000016,
                        "resourceName": "oracle_tenant"
                    }
                ],
                "serverIp": "xxx.xxx.xxx.2",
                "startTime": "2025-04-29T15:43:39+08:00",
                "status": "SUCCESS"
            },
            {
                "clientIp": "xxx.xxx.xxx.1",
                "endTime": "2025-04-29T15:23:14+08:00",
                "eventInfo": "{\"param\":{\"certificateGroupId\":1},\"id\":3000005}",
                "eventType": "OB_PROXY_CLUSTER_MANAGEMENT",
                "executionType": "NEW",
                "failedReason": "please see the log of task id '15038134'",
                "id": 8000316,
                "methodSignature": "com.oceanbase.ocp.server.common.controller.ObproxyController.enableSSL",
                "operationEvent": "ENABLE_OBPROXY_SSL",
                "operatorId": 3001017,
                "operatorName": "docs",
                "requestUrl": "http://xxx.xxx.xxx.2:10550/api/v2/obproxy/clusters/3000005/enableSSL",
                "resourceType": "OB_PROXY_CLUSTER",
                "resources": [
                    {
                        "id": 8000316,
                        "resourceId": 3000005,
                        "resourceName": "obproxy_cluster"
                    }
                ],
                "serverIp": "xxx.xxx.xxx.2",
                "startTime": "2025-04-29T15:23:10+08:00",
                "status": "FAILED",
                "taskId": 15038134
            },
            {
                "clientIp": "xxx.xxx.xxx.1",
                "endTime": "2025-04-29T15:22:40+08:00",
                "eventInfo": "{\"param\":{\"certificateGroupId\":1},\"id\":6000008}",
                "eventType": "OB_CLUSTER_MANAGEMENT",
                "executionType": "RETRY",
                "failedReason": "please see the log of task id '15038130'",
                "id": 8000315,
                "methodSignature": "com.oceanbase.ocp.server.common.controller.ObClusterController.enableSSL",
                "operationEvent": "ENABLE_OB__SSL",
                "operatorId": 3001017,
                "operatorName": "docs",
                "requestUrl": "http://xxx.xxx.xxx.2:10550/api/v2/ob/clusters/6000008/enableSSL",
                "resourceType": "OB_CLUSTER",
                "resources": [
                    {
                        "id": 8000315,
                        "resourceId": 6000008,
                        "resourceName": "ob4252:1658110578"
                    }
                ],
                "startTime": "2025-04-29T15:22:40+08:00",
                "status": "FAILED",
                "taskId": 15038130
            },
            {
                "clientIp": "xxx.xxx.xxx.1",
                "endTime": "2025-04-29T15:22:29+08:00",
                "eventInfo": "{\"param\":{\"certificateGroupId\":1},\"id\":6000008}",
                "eventType": "OB_CLUSTER_MANAGEMENT",
                "executionType": "RETRY",
                "failedReason": "please see the log of task id '15038130'",
                "id": 8000314,
                "methodSignature": "com.oceanbase.ocp.server.common.controller.ObClusterController.enableSSL",
                "operationEvent": "ENABLE_OB__SSL",
                "operatorId": 3001017,
                "operatorName": "docs",
                "requestUrl": "http://xxx.xxx.xxx.2:10550/api/v2/ob/clusters/6000008/enableSSL",
                "resourceType": "OB_CLUSTER",
                "resources": [
                    {
                        "id": 8000314,
                        "resourceId": 6000008,
                        "resourceName": "ob4252:1658110578"
                    }
                ],
                "startTime": "2025-04-29T15:22:28+08:00",
                "status": "FAILED",
                "taskId": 15038130
            },
            {
                "clientIp": "xxx.xxx.xxx.1",
                "endTime": "2025-04-29T15:22:21+08:00",
                "eventInfo": "{\"param\":{\"certificateGroupId\":1},\"id\":6000008}",
                "eventType": "OB_CLUSTER_MANAGEMENT",
                "executionType": "RETRY",
                "failedReason": "please see the log of task id '15038130'",
                "id": 8000313,
                "methodSignature": "com.oceanbase.ocp.server.common.controller.ObClusterController.enableSSL",
                "operationEvent": "ENABLE_OB__SSL",
                "operatorId": 3001017,
                "operatorName": "docs",
                "requestUrl": "http://xxx.xxx.xxx.2:10550/api/v2/ob/clusters/6000008/enableSSL",
                "resourceType": "OB_CLUSTER",
                "resources": [
                    {
                        "id": 8000313,
                        "resourceId": 6000008,
                        "resourceName": "ob4252:1658110578"
                    }
                ],
                "startTime": "2025-04-29T15:22:20+08:00",
                "status": "FAILED",
                "taskId": 15038130
            },
            {
                "clientIp": "xxx.xxx.xxx.1",
                "endTime": "2025-04-29T15:14:25+08:00",
                "eventInfo": "{\"param\":{\"certificateGroupId\":1},\"id\":6000008}",
                "eventType": "OB_CLUSTER_MANAGEMENT",
                "executionType": "NEW",
                "failedReason": "please see the log of task id '15038130'",
                "id": 8000312,
                "methodSignature": "com.oceanbase.ocp.server.common.controller.ObClusterController.enableSSL",
                "operationEvent": "ENABLE_OB__SSL",
                "operatorId": 3001017,
                "operatorName": "docs",
                "requestUrl": "http://xxx.xxx.xxx.2:10550/api/v2/ob/clusters/6000008/enableSSL",
                "resourceType": "OB_CLUSTER",
                "resources": [
                    {
                        "id": 8000312,
                        "resourceId": 6000008,
                        "resourceName": "ob4252:1658110578"
                    }
                ],
                "serverIp": "xxx.xxx.xxx.2",
                "startTime": "2025-04-29T15:14:23+08:00",
                "status": "FAILED",
                "taskId": 15038130
            },
            {
                "clientIp": "xxx.xxx.xxx.1",
                "endTime": "2025-04-29T15:00:47+08:00",
                "eventInfo": "{\"request\":{\"menuPermissions\":[{\"menus\":[\"*\"],\"type\":\"CREDENTIAL\"},{\"menus\":[\"HOST\",\"ALARM\",\"DASHBOARD\",\"INFORMATION\",\"PLAN\",\"INSPECTION\",\"LOG\",\"PACKAGE\",\"CREDENTIAL\",\"CERTIFICATE\",\"TAG\",\"PROPERTY\",\"TASK\"],\"type\":\"GLOBAL\"},{\"menus\":[\"*\"],\"type\":\"ALARM\"},{\"menus\":[\"*\"],\"type\":\"PROPERTY\"},{\"menus\":[\"*\"],\"type\":\"LOG\"},{\"menus\":[\"*\"],\"type\":\"TAG\"},{\"menus\":[\"*\"],\"type\":\"HOST\"},{\"menus\":[\"*\"],\"type\":\"INSPECTION\"},{\"menus\":[\"*\"],\"type\":\"TASK\"},{\"menus\":[\"*\"],\"type\":\"PLAN\"},{\"menus\":[\"*\"],\"type\":\"DASHBOARD\"},{\"menus\":[\"*\"],\"type\":\"INFORMATION\"},{\"menus\":[\"*\"],\"type\":\"PACKAGE\"},{\"menus\":[\"*\"],\"type\":\"CERTIFICATE\"}],\"organizationId\":10000000,\"permissions\":[],\"rolePermissions\":[{\"actionGroupKey\":\"ARBITRATION_READ\",\"resources\":[\"*\"]}]},\"id\":5001001}",
                "eventType": "OCP_USER_MANAGEMENT",
                "executionType": "NEW",
                "id": 8000311,
                "methodSignature": "com.oceanbase.ocp.server.common.controller.IamController.updateRole",
                "operationEvent": "UPDATE_ROLE",
                "operatorId": 3001017,
                "operatorName": "docs",
                "requestUrl": "http://xxx.xxx.xxx.2:10550/api/v2/iam/roles/5001001",
                "resourceType": "OCP_ROLE",
                "resources": [
                    {
                        "id": 8000311,
                        "resourceId": 5001001,
                        "resourceName": "test01"
                    }
                ],
                "serverIp": "xxx.xxx.xxx.2",
                "startTime": "2025-04-29T15:00:47+08:00",
                "status": "SUCCESS"
            },
            {
                "clientIp": "xxx.xxx.xxx.1",
                "endTime": "2025-04-29T14:51:45+08:00",
                "eventInfo": "{\"request\":{\"menuPermissions\":[{\"menus\":[\"*\"],\"type\":\"CREDENTIAL\"},{\"menus\":[\"HOST\",\"ALARM\",\"DASHBOARD\",\"INFORMATION\",\"PLAN\",\"INSPECTION\",\"LOG\",\"PACKAGE\",\"CREDENTIAL\",\"CERTIFICATE\",\"TAG\",\"PROPERTY\",\"TASK\"],\"type\":\"GLOBAL\"},{\"menus\":[\"*\"],\"type\":\"ALARM\"},{\"menus\":[\"*\"],\"type\":\"PROPERTY\"},{\"menus\":[\"*\"],\"type\":\"LOG\"},{\"menus\":[\"*\"],\"type\":\"TAG\"},{\"menus\":[\"*\"],\"type\":\"HOST\"},{\"menus\":[\"*\"],\"type\":\"INSPECTION\"},{\"menus\":[\"*\"],\"type\":\"TASK\"},{\"menus\":[\"*\"],\"type\":\"PLAN\"},{\"menus\":[\"*\"],\"type\":\"DASHBOARD\"},{\"menus\":[\"*\"],\"type\":\"INFORMATION\"},{\"menus\":[\"*\"],\"type\":\"PACKAGE\"},{\"menus\":[\"*\"],\"type\":\"CERTIFICATE\"}],\"organizationId\":10000000,\"permissions\":[],\"rolePermissions\":[{\"actionGroupKey\":\"BINLOG_MANAGE\",\"resources\":[\"*\"]}]},\"id\":5001001}",
                "eventType": "OCP_USER_MANAGEMENT",
                "executionType": "NEW",
                "id": 8000310,
                "methodSignature": "com.oceanbase.ocp.server.common.controller.IamController.updateRole",
                "operationEvent": "UPDATE_ROLE",
                "operatorId": 3001017,
                "operatorName": "docs",
                "requestUrl": "http://xxx.xxx.xxx.2:10550/api/v2/iam/roles/5001001",
                "resourceType": "OCP_ROLE",
                "resources": [
                    {
                        "id": 8000310,
                        "resourceId": 5001001,
                        "resourceName": "test01"
                    }
                ],
                "serverIp": "xxx.xxx.xxx.2",
                "startTime": "2025-04-29T14:51:44+08:00",
                "status": "SUCCESS"
            },
            {
                "clientIp": "xxx.xxx.xxx.1",
                "endTime": "2025-04-29T14:50:57+08:00",
                "eventInfo": "{\"request\":{\"menuPermissions\":[{\"menus\":[\"*\"],\"type\":\"CREDENTIAL\"},{\"menus\":[\"HOST\",\"ALARM\",\"DASHBOARD\",\"INFORMATION\",\"PLAN\",\"INSPECTION\",\"LOG\",\"PACKAGE\",\"CREDENTIAL\",\"CERTIFICATE\",\"TAG\",\"PROPERTY\",\"TASK\"],\"type\":\"GLOBAL\"},{\"menus\":[\"*\"],\"type\":\"ALARM\"},{\"menus\":[\"*\"],\"type\":\"PROPERTY\"},{\"menus\":[\"*\"],\"type\":\"LOG\"},{\"menus\":[\"*\"],\"type\":\"TAG\"},{\"menus\":[\"*\"],\"type\":\"HOST\"},{\"menus\":[\"*\"],\"type\":\"INSPECTION\"},{\"menus\":[\"*\"],\"type\":\"TASK\"},{\"menus\":[\"*\"],\"type\":\"PLAN\"},{\"menus\":[\"*\"],\"type\":\"DASHBOARD\"},{\"menus\":[\"*\"],\"type\":\"INFORMATION\"},{\"menus\":[\"*\"],\"type\":\"PACKAGE\"},{\"menus\":[\"*\"],\"type\":\"CERTIFICATE\"}],\"organizationId\":10000000,\"permissions\":[],\"rolePermissions\":[{\"actionGroupKey\":\"HOST_MAINTAIN\",\"resources\":[\"*\"]}]},\"id\":5001001}",
                "eventType": "OCP_USER_MANAGEMENT",
                "executionType": "NEW",
                "id": 8000309,
                "methodSignature": "com.oceanbase.ocp.server.common.controller.IamController.updateRole",
                "operationEvent": "UPDATE_ROLE",
                "operatorId": 3001017,
                "operatorName": "docs",
                "requestUrl": "http://xxx.xxx.xxx.2:10550/api/v2/iam/roles/5001001",
                "resourceType": "OCP_ROLE",
                "resources": [
                    {
                        "id": 8000309,
                        "resourceId": 5001001,
                        "resourceName": "test01"
                    }
                ],
                "serverIp": "xxx.xxx.xxx.2",
                "startTime": "2025-04-29T14:50:57+08:00",
                "status": "SUCCESS"
            }
        ],
        "page": {
            "number": 1,
            "size": 10,
            "totalElements": 44,
            "totalPages": 5
        }
    },
    "duration": 22,
    "server": "74f95ea2f4",
    "status": 200,
    "successful": true,
    "timestamp": "2025-04-29T17:42:37.246+08:00",
    "traceId": "05c8c34123194eb9"
}

Previous topic

Query OCP application status
Last

Next topic

Query OCP Agent details on a host
Next
What is on this page
Feature description
Call instructions
Interface constraints
Request path
Parameters
Returned result
Example
Request example
Response example