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

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

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

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

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

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Cloud Platform

V4.5.1
  • What's New
    • What's New
  • Product Introduction
    • What is OceanBase Cloud Platform
    • Feature differences between the Enterprise Edition and Community Edition
    • System architecture
    • Features
    • Limits
      • System requirements
      • Dependencies
  • Deploy OceanBase Cloud Platform (OCP)
    • Deploy OceanBase Cloud Platform (OCP) Enterprise Edition
      • Deployment overview
        • Deploy OCP cluster in the Single-node
        • Deploy OCP cluster in the High-availability
      • Prepare the deployment environment
        • Install OAT
        • Add a server
        • Check the environment
      • Deploy OCP
        • Plan resources
          • Host resources
          • OCP service resources
          • MetaDB Resources
          • MonitorDB Resources
        • Deploy OCP
          • Prepare installation media
          • Create MetaDB
          • Install OCP
          • Register an OCP cluster
          • Initialize system parameters
        • Check after deployment
      • Deployment FAQ
        • Optimize MonitorDB parameters
        • F5 Big-IP LTM and alert configuration
          • Connect OBProxy to F5 Big-IP LTM
          • Connect OCP-Console to F5 Big-IP LTM
          • Monitor the OCP service health
        • Ubuntu deployment FAQ
        • EulerOS deployment FAQ
        • Client requirements
        • Start and stop OCP
      • Appendix
        • Uninstall OCP
        • Check the NTP offset
    • Deploy OceanBase Cloud Platform (OCP) Community Edition
      • Overview
      • Installation process
      • Installation planning
        • User planning
        • Host planning
        • Disk and directory planning
        • Port planning
      • Prepare for the installation
      • Deploy OCP on the GUI
      • Use Docker to deploy OCP
      • Post-deployment check
      • Appendix
        • Install Docker
        • Uninstall OCP
        • Restart OCP
        • FAQ about deployment
  • 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 Security and Secrets
      • Appendix
        • Change a user's password
        • Version mapping
    • Upgrade OceanBase Cloud Platform (OCP) Community Edition
      • Upgrade OCP on the GUI
      • Upgrade OCP using Docker containers
      • Post-upgrade check
  • 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
    • Overview
    • Create a cluster
      • Create a distributed cluster
      • Create a standalone cluster
      • Create an AI cluster
    • Manage clusters
      • Create a standby cluster
      • View cluster details
      • 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
        • Add an arbitration service group
        • Replace the arbitration service for a cluster
        • Remove an arbitration service
      • Enable automatic detection of deadlocks
      • Disable automatic detection of deadlocks
      • Manage O&M configuration
        • Overview
        • Manage parameters
        • View the parameter modification history
        • Configure resources for OCP Agent
      • Manage CPU binding configurations
      • View tenant-level information
      • Import a license
      • View the license
    • Manage zones of a cluster
      • Add a Zone
      • Edit a zone
      • Restart a zone
      • Stop a zone
      • Delete a zone
    • 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
    • Upgrade version
    • View the topology of a cluster
    • View the cluster tenant management overview
    • View real-time monitoring data
    • Manage cluster resource
      • View the unit distribution
      • View resource usage
    • 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
    • Manage security configurations
      • Manage SSL Link Encryption
      • Manage TDE
    • Manage SQL Audit
    • Manage cluster parameters
      • Parameter types
      • View parameters
      • Modify parameters
      • View the history of parameter changes
    • 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 Service Groups
      • Overview
      • Create an arbitration service group
      • Upgrade an arbitration service group
      • Edit an arbitration service group
      • Delete an arbitration service group
    • Manage cluster parameter templates
  • Tenant Management
    • Tenant and resource management
    • View tenant overview information
    • Create a primary tenant
    • Manage tenants
      • Overview of the Tenant Details Page
      • 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
      • Change the synchronization configuration
      • Enable Asymmetric Zone
      • Configure end-to-end tracing for a tenant
      • Manage tenant parameters
      • Change the primary/standby protection mode
      • Modify the allowlist of a tenant
      • Modify the zone priority
      • Manage the binlog service for a tenant
      • Manage service names
    • Manage topulogy of a tenant
      • View tenant topology
      • View the topology of the primary/standby relationships of a tenant
    • Manage replicas of a tenant
      • Add a replica
      • Edit tenant replicas in a zone
      • Delete a tenant replica from a zone
      • Delete a unit
    • Manage databases
    • Manage users and permissions under a tenant
      • Manage users in a MySQL tenant
      • Manage user under an Oracle tenant
        • User overview under an Oracle tenant
        • Create a user under an Oracle tenant
        • Lock an Oracle tenant user
        • Change the password of a user under an Oracle tenant
        • Delete a user under an Oracle tenant
        • Create a role under an Oracle tenant
        • Manage users
        • Manage roles
      • System permissions
    • 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 the resources of a tenant
    • Manage major compaction under a tenant
      • Modify major compaction settings of a tenant
      • View details of tenant major compaction
      • Perform a major compaction
      • View the major compaction records
    • Manage statistical information
      • Overview
      • Collect statistics
      • Manage statistics collection tasks
    • Manage tenant parameters
      • View the parameters
      • Modify parameters
      • View the parameter modification history
    • Manage unit specifications
    • View the OCP resource unit specification table
    • Manage tenant parameter templates
  • OBProxy Management
    • OBProxy management overview
    • View details on the OBProxy page
    • Create an OBProxy cluster
    • 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
      • Add an OBProxy
      • Take over OBProxy
      • Delete an OBProxy
      • Restart an OBProxy
      • Stop or start an OBProxy
      • Remove an OBProxy
      • Launch an OBProxy
      • Upgrade an OBProxy
      • Refresh OBProxy configurations
    • Request analysis
    • Manage security configurations
    • Manage OBProxy cluster parameters
    • Client configuration
    • Manage OBProxy parameter templates
    • OBProxy parameters descpription
  • Binlog Service Management
    • Overview of Binlog service
    • Create a Binlog Cluster
    • Manage Binlog Clusters
      • View information about a binlog cluster
      • Upgrade a binlog cluster
      • Start and stop a binlog cluster
      • Restart a binlog cluster
      • Delete a binlog cluster
      • Manage binlog cluster parameters
    • Manage Binlog Instance
      • View a binlog instance
      • Add an instance replica
      • Configure throttling
      • Start and stop a binlog instance
      • Restart a binlog instance
      • Switch primary and standby instances
      • Delete 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 parameter templates
  • 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
    • Manage Host Types
    • Manage IDCs
    • Manage Regions
  • Logservice Instance Management
    • Logservice Instance
    • Parameter Templates
    • Manage Logservice Clusters
      • Cluster List
      • Add a LogServer
      • Create a Logservice cluster
      • Cluster Overview
      • Performance Monitoring
      • Parameter Management
  • Alert Management
    • Overview
    • Alert-related concepts
    • View the alert overview
    • Manage alert rules
      • Create an alert rule
      • View an alert rule
      • Copy an alert rule
      • Edit an alert rule
      • Delete an alert rule
      • Alert rule groups
      • Export alert rule configurations
    • 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
      • Sample alert channel settings
    • 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
      • Create a blocking condition
      • Edit an alert blocking condition
      • Delete an alert blocking condition
    • OCP alert template tag
    • Optional monitoring metrics for custom alerts
  • Dashboard Management
    • Monitoring dashboard overview
    • Manage dashboards
    • Manage groups
    • Manage charts
  • Performance Monitoring
    • Manage monitoring
      • Overview of OceanBase Cloud Platform
      • View database performance
      • View host performance monitoring data
      • View OBServer node performance monitoring data
      • View performance and SQL
      • View transaction performance monitoring data
      • View storage and cache
      • 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
    • Use the custom monitoring feature
      • Overview
      • View collection items
      • Manage indicator items
        • Create a metric
        • Manage metrics
      • Manage charts
        • Create a chart
        • Manage charts
      • OCP metrics
  • 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
      • Transaction overview
      • Diagnose transactions
      • Diagnose XA transactions and suspended transactions
    • Manage sessions
      • Manage the sessions of a tenant
      • View session statistics
      • View the deadlock history
      • View row lock analytics
    • View materialized views
    • View the Optimization Center page
    • View the capacity center
    • View diagnostics reports
      • Manage performance reports
      • Manage ASH reports
  • O&M Management
    • Manage information collection
      • Overview
      • Configure information collection items
      • Create an information collection task
      • View information collection details
      • Download an information collection report
    • Manage plans
      • Overview
      • Manage plans
      • View plan execution details
    • Manage inspections
      • Overview
      • Configure inspection items
      • Configure scheduling rules
        • Configure a scheduling rule for a single inspection object
        • Configure global scheduling rules
      • Initiate an 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
    • 325.manage-sop
      • Overview of Standard O&M Process
      • Create a standard operation and maintenance process
      • View execution details of a standard operation and maintenance process
    • Manage scheduled tasks
      • Overview of Scheduled Tasks
      • Create a scheduled task
      • Manage scheduled tasks
      • View scheduled task details
    • Manage the report center
  • AI Assistant
    • Overview
    • Enable AI-powered intelligent conversation
    • Manage an AI intelligent conversation
  • Backup and Recovery
    • Overview
    • Backup and restore guide
    • Overview
    • Backup now
      • Back up a cluster now
      • Perform tenant backup immediately
    • Regular backup
      • Manage cluster-level backup strategy
        • Create a cluster-level backup policy
        • Modify a cluster-level backup strategy
        • Delete a cluster-level backup strategy
        • Pause backup scheduling
        • View the cluster-level backup strategy
      • 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 tenant-level backup strategies
    • Manage backup tasks
      • View backup tasks
      • View second backup tasks
    • Initiate recovery
    • Regular recovery
      • Create a sampling strategy for recovery
      • View sampling strategies
      • View sampling tasks
    • View restore task information
    • Copy a restore task
    • 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
  • Disaster Recovery
    • Switching primary and standby tenants
      • Switchover
      • Failover
      • Decouple a standby tenant from its primary tenant
      • Create primary and standby tenants across OCP clusters
    • Switching primary and standby databases
      • Routine primary/standby cluster switchover
      • Primary/Standby cluster switchover for disaster recovery
      • Decouple a standby cluster from the primary cluster
      • Start the original primary cluster in read-only mode after a failover
    • 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
    • Query logs
    • Download logs
    • Configure trace query parameters
    • Trace query
    • About OpenSearch
    • Configure log retention strategies
  • Software Package Management
    • Upload a software package
    • Download a software package
    • Delete 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 certificates
      • Certificate overview
      • Upload a certificate
      • Delete a certificate
    • Manage users and permissions
      • Overview
      • Manage a organization
        • Create an organization
        • View the resources of an organization
        • Rename an organization
        • Share resource configurations
        • Delete an organization
      • Manage a role
        • Create a role
        • View a role
        • Edit a role
        • Copy a role
        • Delete a role
        • Default OCP roles
      • Manage a user
        • Create a user
        • View a user
        • Edit a user
        • Copy a user
        • Change the password of a user
        • Delete a user
        • View the login history
    • Manage tags
      • Overview
      • Create a tag
      • Modify objects bound to a tag
      • Edit a tag
      • Delete a tag
    • View operation records
    • Manage external integration
      • Manage AI models
        • Connect to an AI model vendor
        • Add a model
        • Set a system model
        • Delete a model
      • Manage SSO integration
        • Overview
        • Configure SSO integration
        • Enable/Disable an SSO integration task
        • Edit an SSO integration task
        • Delete an SSO integration task
      • Manage SQL audit
        • Overview of SQL Audit Integration with SLS and ES
        • Connect SQL Audit to SLS
        • Connect SQL Audit to ElasticSearch
      • Manage Prometheus
        • Overview of Prometheus
        • Create a Prometheus data source
        • Manage Prometheus data sources
      • Manage Object Storage
        • Overview of object storage
        • Create an object storage configuration
        • Delete object storage configuration
        • Object storage best practices
    • View platform monitoring data
    • Manage system parameters
      • View system parameters
      • Modify system parameters
      • OCP configuration parameters
    • Manage tasks
    • User center management
      • Configure personal information
      • Change your logon password
      • Log off the OCP console
  • SQL Tuning Practices
    • Locate General Abnormal SQL Statements
      • How can I locate SQL statements with high CPU load in a tenant?
      • How can I locate slow SQL statements that take a long time in a tenant?
      • How can I locate SQL statements for full-table scans in a tenant?
      • How can I locate distributed SQL statements in a tenant?
      • How can I locate remote SQL statements 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?
    • 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
    • Upgrade an OceanBase cluster
    • Migrate a resource unit from an OceanBase Database tenant
    • Expand the high availability of OceanBase clusters and tenants
    • Reduce the high availability of OceanBase clusters and tenants
    • Scale out an OceanBase cluster and scale up an OceanBase Database tenant
    • Scale in an OceanBase cluster and scale down an OceanBase Database tenant
    • Troubleshoot host issues in an OceanBase cluster
    • Migrate a cluster between IDCs in OCP
    • Migrate an OceanBase cluster to another IDC
    • Perform a failover between primary and standby OceanBase clusters for disaster recovery in a scenario with two IDCs
    • Perform a switchover between primary and standby OceanBase Database tenants in a scenario with two IDCs
    • Use the arbitration service of OceanBase Database to achieve HA in a scenario with two IDCs
    • Achieve high availability through an arbitration service group
    • Scale out an OBProxy cluster
    • Scale in an OBProxy cluster
    • Replace an OBProxy
    • Move out an OBProxy cluster
    • Take over OBProxies
    • Delete an OBProxy
    • SSL Link Encryption
    • Perform a failover
    • Decouple a standby tenant from the primary tenant
    • Automatic routing to the new primary tenant after a switchover
    • Back up an OceanBase cluster
    • Restore lost data by using backup and restore
    • Monitor the business load of OceanBase Database
    • Integrate OCP monitoring with Prometheus
    • Import a monitoring dashboard to Grafana
    • Configure custom monitoring
    • Perform an inspection in OCP to detect potential risks in an OceanBase cluster
    • Check clog synchronization
    • Check the NIC rate
    • Check the availability of an auto-increment column
    • Send alert messages to a DingTalk group
    • Send alert messages to a Feishu group
    • Send alert messages to a WeChat Enterprise group
    • Send alert messages through email
    • Push alert messages through HTTP
    • Connect alerts to a Slack channel
    • Organization and permission management
    • Perform failover using standard O&M procedures
  • Reference Guide
    • Alarm reference
      • Overview
      • 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
        • standby_cluster_sync_status_error Standby cluster synchronization status exception
        • ob_tenant_tde_kms_host_not_match Tenant TDE KMS service address does not match the current OCP service address
        • ob_tenant_tde_kms_cmk_info_not_exist Tenant TDE key information does not exist in the current OCP. Please update the tenant TDE key promptly.
        • tenant_all_unit_server_not_connectable OceanBase Tenant Cannot Be Connected
        • ob_tenant_mview_refresh_delay Materialized View Automatic Refresh Delay
        • ob_tenant_mview_refresh_error Tenant Materialized View Automatic Refresh Exception
        • tenant_vector_mem_used_percent_over_threshold OceanBase Tenant Vector Index Actual Memory Usage Exceeds Threshold
        • tenant_mini_merge_tablet_count_error Number of Tablets Exceeding the Limit for Minor Compaction SSTables in an OceanBase Tenant
        • tenant_compact_timeout_count_error Number of OceanBase Tenant Partitions (sstables) That Have Not Been Compacted for a Long Time
        • ob_tenant_session_kill_delay Tenant Session Killed Delay
        • ob_tenant_info_sync_failed OceanBase Tenant Information Synchronization Failed
        • ob_tenant_name_mismatch The tenant name of the OceanBase tenant has changed.
        • tenant_compaction_status_is_suspend Tenant Major Compaction Suspended
        • ob_tenant_service_name_is_invalid Tenant service name is invalid.
        • cluster_cgroup_value_inconsistent Inconsistent cgroup values in the cluster
        • ob_tenant_log_stream_replica_absent Absent Replica in OceanBase Tenant Log Stream
        • ob_tenant_log_stream_leader_absent OceanBase Tenant Log Stream Leader Absent
        • arbitration_node_connection_with_observer_error Unable to connect observer on the arbitration node
      • Application alerts
        • ob_cluster_inspection_not_passed
        • ob_host_ssd_wear_indicator_over_threshold
        • ob_host_mem_percent_over_threshold Host memory usage exceeds the threshold
        • ob_host_net_recv_percent_over_threshold Host network receive bandwidth usage exceeds threshold
        • ob_host_net_send_percent_over_threshold The server's network send bandwidth usage exceeds the threshold.
        • ob_host_tcp_retrans_percent_over_threshold The percentage of TCP retransmissions exceeding the threshold on the server
        • ob_host_cpu_percent_over_threshold CPU usage on the server exceeds the threshold
        • inc_backup_delay
        • base_backup_fail
        • base_backup_too_long_time_no_one_success_task
        • backup_process_dead
        • backup_storage_capacity_over_threshold
        • log_backup_storage_space_over_threshold Log Backup Storage Space Exceeds Threshold
        • backup_storage_capacity_retry_times_exceeded The maximum number of retries to obtain backup storage capacity has been exceeded.
        • backup_storage_capacity_timeout_or_interrupted Backup restore directory capacity retrieval timeout or thread interrupted
        • ocp_remote_server_time_diff_too_large
        • monitor_exporter_unavaliable A monitoring exporter is unavailable on the server.
        • system_obproxy_unavailable
        • host_unavailable
        • host_ntp_offset_too_large The offset between the host and the NTP server is too large.
        • host_ntp_service_not_exist The NTP service does not exist on the server.
        • host_agent_res_memory_over_threshold Server Agent Memory Over Threshold
        • host_agent_open_fd_count_over_threshold The number of open file descriptors for the server agent exceeds the threshold.
        • host_agent_goroutine_count_over_threshold The number of goroutines for the server agent exceeds the threshold.
        • partition_create_failed
        • obagent_dead Agent service unavailable
        • host_disk_readonly
        • ic_server_connect_failed Inter-Connector server connection failed
        • vpc_connect_failed VPC connection failed
        • node_load1_peak
        • Host log alerts
        • base_backup_timeout
        • base_secondary_backup_fail
        • ocp_meta_db_disconnected OCP Meta Database Disconnected
        • ocp_http_request_timeout
        • ocp_http_request_too_many_errors_occur
        • ocp_alarm_detect_timeout
        • odp_instance_compress_failed
        • odp_instance_expanse_failed
        • odp_sql_execute_failed
        • odp_sql_query_slow
        • agentd_process_stop
        • mgragent_process_stop ocp_mgragent process stop
        • monagent_process_stop
        • ocp_contingency_failed
        • ob_host_invalid_disk_exists OBServer has a bad disk
        • ob_cluster_recyclebin_disk_used_over_threshold
        • ob_host_monitordb_disconnected OCP-Agent cannot connect to monitordb
        • upgrade_ocp_agent_failed
        • host_agent_version_not_same
        • ocp_collect_metric_failure_rate_high OCP-Server collects metrics with a high failure rate
        • ssl_certificate_is_expired SSL certificate expiration alert
        • message_hardware_error Host hardware failure
        • ob_license_expired
        • binlog_process_stop Stop a Binlog Server process
        • binlog_process_dead Binlog Server process does not exist
        • ocp_system_cpu_usage_over_threshold OCP Node CPU Usage Exceeds Threshold
        • ocp_disk_percent_over_threshold OCP Node Disk Usage Exceeds Threshold
        • ocp_jvm_heap_memory_used_percent_over OCP Node JVM Heap Memory Usage Exceeds Threshold
        • ocp_distributed_server_deleted_count OCP Node Offline
        • message_log_alarm System Message Logs
        • system_parameter_not_taken_effect System parameter modification requires a restart to take effect
        • host_process_cpu_bind_core_is_invalid CPU Binding Configuration Inconsistent
        • ob_server_stopped Server Stop Service
      • 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
      • LogService alerts
        • logservice_process_stop Stop the OBLOBSERVICE process
        • logservice_process_dead LogService process does not exist
        • logservice_rpc_request_timeout OBLOBSERVICE RPC Request Timeout
        • logservice_replica_committed_end_scn_delay Delay of End SCN for Committed Logs in OBLOGLayer
        • logservice_cluster_operation_info LogService Cluster O&M Operation Reminder
        • logservice_host_operation Maintenance Operation Reminder for LogService Cluster Nodes
      • 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
      • 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
        • Enable JVM Environment Dependency Service
        • Edit JVM Environment Dependency Service
        • Stop the JVM environment dependency service
      • Tenant management
        • Query tenants of a cluster
        • Query all tenants
        • Query details about a tenant
        • Create a tenant
        • Create a standby tenant
        • Delete a tenant
        • Lock a tenant
        • Unlock a tenant
        • Query units of a tenant
        • Delete a unit from a tenant
        • Add a replica for a tenant
        • Delete a replica of a tenant
        • Modify a replica of a tenant
        • Modify zone priorities of a tenant
        • Change the administrator password of a tenant
        • Modify the allowlist of a tenant
        • Query parameters of a tenant
        • Modify parameters of a tenant
        • Obtain a list of unit specifications
        • Create a resource unit specification
        • Delete a resource unit specification
        • Perform a switchover precheck
        • Perform a switchover
        • Perform a batch switchover precheck
        • Perform a batch switchover
        • Perform a failover precheck
        • Perform a failover
        • Perform a batch failover precheck
        • Perform a batch failover
      • OBProxy management
        • Create an OBProxy cluster
        • Delete an OBProxy cluster
        • Query OBProxy clusters
        • Query details about an OBProxy cluster
        • Update configurations of an OBProxy cluster
        • Add an OBProxy
        • Take over an OBProxy
        • Delete an OBProxy
        • Delete an OBProxy (not recommended)
        • Restart an OBProxy
        • Restart an OBProxy
        • Upgrade an OBProxy
        • Upgrade an OBProxy
        • Add a connectable OceanBase cluster to an OBProxy cluster
        • Remove a connectable OceanBase cluster from an OBProxy cluster
        • Query the description information of the OBProxy parameters
        • Query parameters of an OBProxy cluster
        • Stop an OBProxy
        • Start an OBProxy
      • Database management
        • Query databases
        • Create a database
        • Modify a database
        • Delete a database
        • Query the list of database users
        • Query database user details
        • Create a database user
        • Delete a database user
        • Change the password of a database user
        • Lock a database user
        • Unlock a database user
        • Query the list of database roles
        • Query database role details
        • Create a database role
        • Delete a database role
        • Query database objects
        • Grant global privileges to a user
        • Revoke global privileges of a user
        • Change global privileges of a user
        • Grant global privileges to a role
        • Revoke global privileges of a role
        • Change global privileges of a role
        • Grant roles to a user
        • Revoke roles of a user
        • Change roles of a user
        • Grant roles to a role
        • Revoke roles of a role
        • Change roles of a role
        • Grant database privileges to a user
        • Revoke database privileges of a user
        • Change database privileges of a user
        • Grant object privileges to a user
        • Revoke object privileges of a user
        • Change object privileges of a user
        • Grant object privileges to a role
        • Revoke object privileges of a role
        • Change object privileges of a role
      • Monitoring
        • Query the description of a monitoring metric
        • Query monitoring data
        • Query monitoring data by tag
      • Alerts
        • Call an alert API
        • Obtain current alerts
        • Obtain alert history
        • Query alert events
      • 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
      • SQL performance
        • Query performance metrics of an SQL statement
        • Query the performance indicator trend of an SQL statement
        • Query SQL text
        • Query the performance indicator trend of an execution plan
        • Query the operator structure of an execution plan
        • Query the list of slow SQL statements
        • Query snapshots
        • Generate a performance report
        • Query a performance report
      • Backup and recovery
        • Query backup capabilities of a cluster
        • Create a backup strategy for a cluster
        • Modify the backup strategy of a cluster
        • Delete the backup strategy of a cluster
        • Query the backup strategy of a cluster
        • Query the backup overview of a cluster
        • Query data backup tasks of a cluster
        • Query log backup tasks of a cluster
        • Query recovery tasks of a cluster
        • Immediately back up a cluster
        • Parse cluster backup data
        • Start backup scheduling for a cluster
        • Stop backup scheduling for a cluster
        • Initiate tenant/database/table restore
        • Preview a restore task
        • Add restore resources
        • Clear added restore resources
        • Initiate a data backup for a tenant
        • Create a backup strategy for a tenant
        • Delete the backup strategy of a tenant
        • View the data backup tasks of a tenant
        • View the log backup tasks of a tenant
        • View restore tasks
        • Parse the backup information of a tenant
        • Query the backup strategy of a tenant
        • Modify the backup strategy of a tenant
        • Start backup scheduling for a tenant
        • Stop backup scheduling for a tenant
        • Parse global backup information
        • Initiate tenant restore globally
      • 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
      • Software packages
        • Query software packages
        • Upload a software package
        • Delete a software package
      • O&M tasks management
        • Query tasks
        • Query details about a task
        • Retry a task
        • Roll back a task
        • Query subtask logs
        • Retry a subtask
        • Skip a subtask
        • Cancel a subtask
      • 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
          • Query OCP Agent details on a host
          • Stop the OCP Agent process on a host
          • Batch stop the OCP Agent processes on hosts
          • Restart the OCP Agent process on a host
          • Batch restart the OCP Agent processes on hosts
          • Query OCP Agent processes on a host
          • Restart the OCP Agent process on a host
          • Stop the OCP Agent process on a host
      • 1800.sop
        • Query SOP type list
        • Query the default steps for a specified type
        • Create an SOP task
        • Query SOP Task List
        • Query SOP task details
        • Edit an SOP task
        • Start an SOP task
        • Delete an SOP task
        • Query SOP execution details
        • Proceed to the next step
        • Retry all failed steps
        • Retry a specified failed step
        • Update the auto-execution switch or step parameters for unexecuted steps
    • Metric reference
      • Overview of metrics
      • Monitoring metrics list
      • OceanBase cluster
        • Database performance
          • QPS
          • Query response time
          • TPS
          • Transaction response time
          • Number of sessions
          • Request queue time
          • Number of transaction logs
          • Transaction log volume
          • Time consumed by transaction logs
          • IOPS
          • IO time-consuming
          • I/O Throughput
          • TPS
        • OBServer performance
          • Process memory
          • Process CPU utilization
          • Process file descriptors
          • Number of process threads
          • sys500 memory occupation
          • Error logs
      • 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
          • PX worker thread usage
          • Clog synchronization delay
          • DB time metrics
          • SQL execution phase
          • Frontend workload
          • Background workload metrics
          • RPC Request Success Rate
          • Number of GTS Requests
          • RPC Network Latency
          • RPC Delivery Failure
        • Transaction
          • TPS
          • Transaction response time
          • Transaction response time details
          • Transaction Rollback Ratio
          • 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
          • MemStore Lock Request Success Rate
        • Storage and Cache
          • MemStore
          • IOPS
          • IO time-consuming
          • I/O Throughput
          • Cache size
          • Cache hit rates
          • Number of cache requests
          • Vector Index Data Size
          • Actual Usage Percentage of Vector Index Data
          • Frozen MEMStore
          • Log disk
          • Data Disk
          • Minor compaction partitions
        • Database objects
          • Objects
        • OBKV_Table
          • QPS (OBKV-Table)
          • Response time (OBKV-Table)
          • Average number of statement lines processed (OBKV-Table)
        • OBKV_HBase
          • QPS (OBKV_Hbase)
          • Response time (OBKV-HBase)
          • Average number of statement lines processed (OBKV-HBase)
        • OBKV_Redis
          • QPS (OBKV-Redis)
          • Response time (OBKV-Redis)
      • Binlog Service
        • Subscription Connection Monitoring
          • Sending Delay
          • Associate RPS
          • Network Traffic
        • Binlog Performance Monitoring
          • Binlog Delay
          • Binlog RPS
        • Binlog Resource Monitoring
          • CPU
          • memory used
          • memory
          • disk used
          • Binlog Disk Write Rate
          • disk ratio
          • FD count
          • network bytes
      • 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
      • 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
          • Process resident memory
          • Process CPU utilization
          • Number of process file descriptors
          • Number of process threads
          • Number of OCP-Agent process goroutines
      • AI Cluster
        • Overview of AI Cluster Monitoring Metrics
        • Logservice
          • Log reception and writing
          • Log latency
          • Log Reading
          • FetchLog Operation
          • RPC Requests
          • HTTP Requests
          • GC Collection
          • Object storage upload
          • Thread Pool
          • Process Resources
          • Latency and Status
        • Shared Storage
          • Macroblock Cache Hit Rate in Shared Storage Mode
          • Macroblock Cache Size in OceanBase Shared Storage Mode
          • Shared data
          • Local Cache Warmup
    • Information Collection Reference
      • Major Compaction Exceptions
        • Collect information about the major compaction status of zones of a cluster
        • Collect information about the ongoing major compaction in a cluster
        • Collect suggestions provided based on historical major compactions
        • Collect diagnostic information about major compactions
        • Collect information about DAG warnings in OceanBase Database
        • Collect RootService task records
        • Collect the last-one-day records of major compaction events scheduled by RootService
        • Collect the checksum information about tablets
        • Collect the checksum information about columns
        • Collect major compaction parameter settings
        • Collect the major compaction time
      • OCP Agent Exceptions
        • Collect panic logs of the mgragent process
        • Collect panic logs of the monagent process
        • Collect information about goroutines of the agent processes
      • 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 processes with high CPU utilization on a cluster node
        • Collect information about threads with high CPU utilization in an observer process
      • Data Disk Full
        • Collect the data disk usage information of nodes in a cluster
        • Collect incremental data generated during cluster compactions
        • Collect information about the disk space occupied by temporary files of a tenant
        • Collect information about sizes of data of different versions in major SSTables
        • Collect information about the macroblock utilization of nodes
      • 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
          • Overview
          • 0001 to 3999
          • 4000 to 4499
          • 4500 to 4999
          • 5000 to 5999
          • 6000 to 6999
          • 7000 to 7999
          • 8000 to 8999
          • 9000 ~ 9499
          • 9500 to 9999
          • 10000 to 12000
          • 22998, 30926, 38104, and 38105
        • Oracle mode
          • Overview
          • OBE-00000 to OBE-00999
          • OBE-01000 to OBE-01499
          • OBE-01500 to OBE-01999
          • OBE-02000 to OBE-04999
          • OBE-05000 to OBE-10000
          • OBE-10000 to OBE-19999
          • OBE-20000 to OBE-29999
          • OBE-30000 to OBE-49999
          • OBE-50000 to OBE-99999
          • PLS-00000 to PLS-00999
  • FAQ
    • FAQ about deployment
    • FAQ on upgrade
    • FAQ on O&M
      • FAQ on accounts and passwords
      • FAQ on host management
      • FAQ about OceanBase clusters
      • FAQ about OceanBase tenants
      • FAQ on OBProxy
      • FAQ on the OCP software package
      • FAQ on backup and recovery
    • 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
    • OCP background tasks
    • Tables managed by the daemon
    • Component listening port list
    • Processes
    • Install and configure OCI
    • Modify the log stream downgrade control time
    • AWS S3 protocol
    • Grafana dashboard
    • Create a Slack channel and obtain its webhook URL
    • Configure cgroup
    • Enable HTTPS Access for Prometheus in OCP
    • Configure SSL for OCP
  • Release Notes
    • Version number guidelines
    • V4.5
      • OCP V4.5.1
      • OCP V4.5.0
    • V4.4
      • OCP V4.4.2
      • OCP V4.4.1
      • OCP V4.4.0
    • V4.3
      • OCP V4.3.6
      • OCP V4.3.5
      • OCP V4.3.4
      • OCP V4.3.3
      • OCP V4.3.2
      • OCP V4.3.1
      • OCP V4.3.0
    • V4.2
      • OCP V4.2.2
      • OCP V4.2.1
      • OCP V4.2.0
    • V4.1
      • OCP V4.1.0
    • V4.0
      • OCP V4.0.3
      • OCP V4.0.2
      • OCP V4.0.1
      • OCP V4.0.0
    • V3.3
      • OCP V3.3.5
      • OCP V3.3.4
      • OCP V3.3.3
      • OCP V3.3.1
      • OCP V3.3.0
    • V3.2
      • OCP V3.2.3
    • V3.1
      • OCP V3.1.2

Download PDF

Document Feedback
  1. Documentation Center
  3. OceanBase Cloud Platform
  5. V4.5.1

Overview

Last Updated:2026-09-21 02:48:38

List of cluster management APIs
Tenant management APIs
OBProxy Management API List
Database management APIs
Monitoring APIs
Alert API List
Inspection API List
SQL Performance API List
Backup and Recovery APIs
Host management APIs
Software package API list
List of O&M task management APIs
System management APIs
SOP API List
Others

To facilitate the management of your OceanBase cluster resources and the development of your own applications through APIs, OCP exposes HTTP APIs that comply with the REST specification. This topic describes the APIs exposed by OCP, including their syntax and examples. It is intended for developers. Before calling the APIs, ensure you have a thorough understanding of the relevant concepts of the OCP platform.

List of cluster management APIs

Module
API name
Description
Cluster Information Query cluster list This API is used to query the information about the OceanBase cluster managed by OCP.
Cluster Information Create an OceanBase cluster This API is used to create an OceanBase cluster.
Cluster Information Delete an OceanBase cluster This API is used to delete an OceanBase cluster.
Cluster Information Stop an OceanBase cluster This API is used to stop an OceanBase cluster.
Cluster Information Start an OceanBase cluster This API is used to start an OceanBase cluster.
Cluster Information Restart an OceanBase cluster This API is used to restart an OceanBase cluster.
Cluster Information Upgrade an OceanBase cluster This API is used to upgrade an OceanBase cluster.
Cluster Information Move out an OceanBase cluster This API is used to migrate out an OceanBase cluster.
Cluster Information Pre-check for taking over an OceanBase cluster This API is used to perform a precheck for taking over an OceanBase cluster.
Cluster Information Take over an OceanBase cluster The interface used to take over an OceanBase cluster.
Cluster Information View the zone list of an OceanBase cluster This API is used to query the zone list of an OceanBase cluster.
Cluster Information Create a zone for an OceanBase cluster This API is used to add a zone to an OceanBase cluster.
Cluster Information Delete a zone from an OceanBase cluster This API is used to delete a zone from a specified OceanBase cluster.
Cluster Information Stop a zone in an OceanBase cluster This API is used to stop a zone of the specified OceanBase cluster.
Cluster Information Start an OceanBase cluster in a zone This API is used to start a zone of the target OceanBase cluster.
Cluster Information Restart zones in an OceanBase cluster This API is used to restart a zone in a specified OceanBase cluster.
Cluster Information Add an OBServer node This API is used to add an OBServer node to a target OceanBase cluster.
Cluster Information Batch delete OBServer nodes This API is used to batch delete OBServer nodes from a target OceanBase cluster.
Cluster Information Stop an OBServer node This API is used to stop an OBServer node in the target OceanBase cluster.
Cluster Information Start an OBServer node This API is used to start an OBServer node in the target OceanBase cluster.
Cluster Information Restart an OBServer node This API is used to restart an OBServer node in the target OceanBase cluster.
Cluster Information Replace an OBServer node An API for replacing an OBServer node in the target OceanBase cluster.
Cluster Information Modify the password of an OceanBase cluster This API is used to modify the password of a target OceanBase cluster.
Cluster Information Obtain parameter metadata of an OceanBase cluster This API is used to obtain the parameter descriptions of an OceanBase cluster.
Cluster Information Obtain the parameter list of an OceanBase cluster This API is used to obtain the parameter list of the target OceanBase cluster.
Cluster Information Modify parameters of an OceanBase cluster This API is used to modify parameters of the target OceanBase cluster.
Cluster Information Query OBServer nodes in an OceanBase cluster This API is used to query information about all OBServer nodes in a cluster.
Cluster Information Query OBServer nodes in a zone This API is used to query OBServer nodes in a specified zone of a cluster.
Cluster Information Pre-check for switchover It is used to check the current status of the primary and standby clusters and determine whether a switchover operation for the OceanBase cluster can be performed normally.
Cluster Information Failover pre-check It is used to check the current status of the primary and standby clusters to determine whether a failover of the OceanBase cluster can be performed normally.
Cluster Information Switchover Daily Switching Specifies to switch the standby cluster to the primary cluster, and at the same time switch the current primary cluster to the standby cluster.
Cluster Information Failover disaster recovery switching The API used to designate a standby cluster as the primary cluster.
Cluster Information Query resource statistics of an OceanBase cluster This API is used to obtain resource statistics of an OceanBase cluster.
Cluster Information Query resource statistics of all OBServer nodes in a cluster This API is used to obtain the resource statistics of all OBServer nodes in a cluster.
Cluster Information Query units of an OceanBase cluster This API is used to obtain the unit list of an OceanBase cluster.
Cluster Information Create an arbitration service This API is used to create an arbitration service.
Cluster Information Query arbitration service details This API is used to query the details of an arbitration service.
Cluster Information Query the arbitration service list This API is used to query the arbitration service list.
Cluster Information Stop an arbitration service This API is used to stop the arbitration service.
Cluster Information Start an arbitration service This API is used to start an arbitration service.
Cluster Information Restart an arbitration service This API is used to restart an arbitration service.
Cluster Information Upgrade an arbitration service This API is used to upgrade an arbitration service.
Cluster Information Delete an arbitration service This API is used to delete an arbitration service.
Cluster Information Query arbitration service parameters This API is used to obtain the list of arbitration service parameters.
Cluster Information Bind/unbind a specified set of tags to/from an arbitration service This API is used to bind or unbind a specified set of tags to/from an arbitration service.
Cluster Information Pre-check for taking over an arbitration service This API is used to perform a pre-check for taking over an arbitration service.
Cluster Information Take over an arbitration service The interface for taking over the arbitration service.
Cluster Information Move out arbitration service This API is used to migrate out an arbitration service.
Cluster Information Pre-check for batch replacing arbitration services This API is used to batch replace the pre-check of an arbitration service.
Cluster Information Batch Replace Arbitration Services This API is used to batch replace arbitration services.
Cluster Information Pre-check for batch association with OceanBase clusters This API is used to batch associate pre-checks for OceanBase clusters.
Cluster Information Batch associate with OceanBase clusters This API is used to batch associate OceanBase clusters.
Cluster Information Batch remove clusters from an arbitration service This API is used to unbind clusters in batches.
Cluster Information Create an arbitration service group This API is used to create an arbitration service group.
Cluster Information Update an arbitration service group This API is used to update an arbitration service group.
Cluster Information Query arbitration service groups This API is used to obtain information about an arbitration service group.
Cluster Information Query arbitration service groups This API is used to obtain the list of arbitration service groups.
Cluster Information Delete an arbitration service group This API is used to delete an arbitration service group.
Cluster Information Upgrade an arbitration service group This API is used to upgrade an arbitration service group.

Tenant management APIs

Module
API name
Description
Tenant Information Query tenants of a cluster Query the tenant list of a cluster.
Tenant Information Query all tenants Query information about all tenants in a cluster managed by OCP.
Tenant Information Query tenant details Query details of a specified tenant.
Tenant Information Create a tenant This API is used to create a single tenant in a specified cluster.
Tenant Information Create a standby tenant This API is used to create a single standby tenant in a specified cluster.
Tenant Information Delete a tenant This API is used to delete a specified tenant from a specified cluster.
Tenant Information Lock a tenant The API used to lock a specified tenant in a specified cluster.
Tenant Information Unlock a tenant This API is used to unlock a specified tenant in a specified cluster.
Tenant Information Query tenant unit lists Query the unit list of a tenant.
Tenant Information Delete a tenant unit This API is used to delete a tenant unit.
Tenant Information Add Tenant Replicas Adds a replica for the specified tenant.
Tenant Information Delete a tenant replica This API is used to delete replicas for a specified tenant.
Tenant Information Modify Tenant Replica This API is used to modify replicas for a specified tenant.
Tenant Information Modify the zone priority of a tenant This API is used to modify the zone priority of a specified tenant.
Tenant Information Modify tenant management password This API is used to modify the management password of a specified tenant.
Tenant Information Modify tenant allowlist The API used to modify the allowlist for a specified tenant.
Tenant Information Query tenant parameters The API used to obtain the tenant parameter list.
Tenant Information Modify tenant parameters Modify tenant parameters.
Tenant Information Query unit specifications Query the unit specification list recorded in OCP.
Tenant Information Create a unit specification Create a resource unit specification.
Tenant Information Delete a unit specification Delete a unit config.
Tenant Information Pre-check for routine switchover This API is used for daily pre-checks before switching.
Tenant Information Daily Switchover An API for routine switching.
Tenant Information Batch Daily Switchover Precheck This API is used to perform batch pre-checks for routine switchover.
Tenant Information Batch daily switchover This API is used for batch daily switching.
Tenant Information Pre-check for disaster recovery switchover This API is used for the pre-check of a disaster recovery switchover.
Tenant Information Disaster recovery switchover This API is used for disaster recovery switchover.
Tenant Information Batch Disaster Recovery Switchover Precheck This API is used for pre-checks of batch disaster recovery switchover.
Tenant Information Batch disaster recovery switchover This API is used for batch disaster recovery switchover.

OBProxy Management API List

Module
API name
Description
OBProxy Management Create an OBProxy cluster The API used to create an OBProxy cluster.
OBProxy Management Delete an OBProxy cluster This API is used to delete an OBProxy cluster.
OBProxy Management Query the OBProxy cluster list The API used to query the OBProxy cluster list information.
OBProxy Management Query details about an OBProxy cluster This API is used to query the details of an OBProxy cluster.
OBProxy Management Update OBProxy cluster configuration This API is used to query the details of an OBProxy cluster.
OBProxy Management Add OBProxy The API used to add an OBProxy to an OBProxy cluster.
OBProxy Management Take over OBProxy The API used to take over OBProxy into an OBProxy cluster.
OBProxy Management Delete an OBProxy The API used to delete an OBProxy.
OBProxy Management Restart an OBProxy instance The API used to restart the OBProxy.
OBProxy Management Upgrade OBProxy The API used to upgrade OBProxy.
OBProxy Management Add an OceanBase cluster to the OBProxy cluster Add an OceanBase cluster that can be connected to the OBProxy cluster.
OBProxy Management Delete an OBProxy cluster that can connect to the OceanBase cluster Delete the association between an OBProxy cluster and an OceanBase cluster.
OBProxy Management Query OBProxy parameters Query the parameter description of OBProxy.
OBProxy Management Query OBProxy cluster parameters Query the OBProxy cluster parameter settings.
Stop OBProxy Modify OBProxy cluster parameters This API is used to stop an OBProxy.
Start OBProxy Query the status of an OBProxy cluster This API is used to start an OBProxy.

Database management APIs

Module
API name
Description
Database Management Query databases The API used to obtain the database list.
Database Management Create a database The API used to create a database.
Database Management Modify a database The API used to modify a database.
Database Management Delete a database The API used to delete a database.
Database Management Query database users Retrieves the list of database user details.
Database Management Query details of a database user Retrieves details of a database user.
Database Management Create a database user Create a database user.
Database Management Delete a database user Delete a database user.
Database Management Modify the password of a database user Modify the password of a database user.
Database Management Lock a database user Lock the database user.
Database Management Unlock a database user Unlock the database user.
Database Management Query database role details Retrieves the list of database role details.
Database Management Query database role details Retrieves details of a database role.
Database Management Create a database role Create a database role.
Database Management Delete a database role Delete a database role.
Database Management Query database objects Retrieves the list of database objects.
Database Management Grant global permissions to users Grant global privileges to the user.
Database Management Revoke global user permissions Revoke global privileges from a user.
Database Management Modify global user permissions Modify user global permissions.
Database Management Grant global permissions to a role Grants global privileges on the role.
Database Management Revoke global permissions of a role Revoke global role permissions.
Database Management Modify global role permissions Modify global role permissions.
Database Management Grant roles to users The role granted to the user.
Database Management Revoke a user's role Revoke a user's role.
Database Management Modify a user's role Modify the user's role.
Database Management Grant roles to roles Modify the role of a role.
Database Management Revoke the role of a role Revoke the role.
Database Management Modify the role of a role Modify the role of a role.
Database Management Grant database privileges to users This API is used to grant database privileges to a user.
Database Management Revoke user database privileges This API is used to revoke certain privileges of a user on a database.
Database Management Modify user database permissions This API is used to modify user privileges on a database.
Database Management Grant object permissions to a user Grants object permissions to a user.
Database Management Revoke user object permissions Revoke user object permissions.
Database Management Modify user object permissions Modify user object permissions.
Database Management Grant role object permissions Grants role object permissions.
Database Management Revoke role object permissions Revoke role object permissions.
Database Management Modify role object permissions Modify role object permissions.

Monitoring APIs

Module
API name
Description
Monitoring Query the metadata of a monitoring metric Query the metadata of OCP monitoring metrics to retrieve the monitoring data for a specified metric.
Monitoring Query monitoring data To query the monitoring data of a specified metric, you must specify the time interval for the query.
Monitoring Query monitoring data and attach a tag to the data To query monitoring data for a specified metric, you need to specify the time interval for the query. The returned results include the values of the grouping tags.

Alert API List

Module
API name
Description
Alert Alert API call example An example of an alert API call.
Alert Get active alerts Query the alert event list.
Alert Get historical alerts Query single alert event information.
Alert Query alert events Query detailed information about a specified alert event.

Inspection API List

Module
API name
Description
Inspection Query the inspection task list This API is used to query the inspection task list.
Inspection Query inspection object list This API is used to query the inspection object list.
Inspection Get inspection report details This API is used to obtain details of an inspection report.
Inspection Initiate an inspection This API is used to initiate an inspection.
Inspection Query the last inspection result of a specified inspection item This API is used to query the last inspection result of a specified inspection item.
Inspection Get the latest inspection result of a specific object This API is used to obtain the most recent inspection result of a specific object.

SQL Performance API List

Module
API name
Description
SQL Performance Query SQL performance statistics Query the SQL performance of a tenant and statistically analyze the SQL performance within a specified time interval. The performance data includes: cluster, tenant, server, database, user, and SQL_ID.
SQL Performance Query the performance statistics trend of an SQL statement Query the performance trend of an SQL statement within a specified time interval.
SQL Performance Query SQL text Query the full text of the SQL statement with the specified ID.
SQL Performance Query execution plan performance statistics trend Query the performance trend of associated execution plans for a specified SQL statement.
SQL Performance Query the operator structure of an execution plan Query the execution plan.
SQL Performance Query the slow SQL list Query the slow SQL list.
SQL Performance Query snapshot information Query the snapshot information of a specified cluster.
SQL Performance Generate a performance report Generate a cluster performance report.
SQL Performance Query performance report Query the cluster performance report.

Backup and Recovery APIs

Module
API name
Description
Backup and Recovery Query the backup capabilities of a cluster Query the backup capabilities of an OceanBase cluster, such as whether backup is supported and what backup methods are available.
Backup and Recovery Create a backup policy for the cluster Creates a backup policy for a cluster. This API allows you to set the backup scheduling cycle, time, and storage address for the cluster, as well as configure options such as expired data cleanup and alert thresholds.
Backup and Recovery Modify the backup policy of a cluster This API is used to modify the backup strategy of a cluster, including the backup scheduling cycle, time, and storage address, as well as information such as expired data cleanup, alert thresholds, and secondary backup configurations.
Backup and Recovery Delete a backup policy for a cluster Delete the backup policy of a cluster. After the backup policy is deleted, the cluster will no longer perform automatic backup scheduling or detect related alerts.
Backup and Recovery Query the backup policy of a specified cluster Query the backup strategy details of an OceanBase cluster.
Backup and Recovery Query the backup overview of a cluster Query the backup overview of a cluster, including basic cluster information, the time of the last data backup, log backup timestamps, log latency, and backup size.
Backup and Recovery Query data backup tasks for a cluster Query data backup tasks for a specified cluster.
Backup and Recovery Query the log backup tasks of a cluster Query the log backup tasks of an OceanBase cluster.
Backup and Recovery Query recovery tasks of a cluster Query the restore tasks of a cluster.
Backup and Recovery Back up a cluster immediately Initiates an immediate backup for a cluster.
Backup and Recovery Parse cluster backup information Parse the backup information of the cluster.
Backup and Recovery Start cluster backup scheduling Starts cluster backup scheduling.
Backup and Recovery Stop cluster backup scheduling Pause cluster backup scheduling.
Backup and Recovery Initiate tenant/database/table recovery Restore the backed-up tenant to the target cluster.
Backup and Recovery Preview restore Preview the restore task and return the paths of all backup resources.
Backup and Recovery Add a restore resource Manually add the resource path for recovery.
Backup and Recovery Clear added restore resources Clear the added restore resource path.
Backup and Recovery Initiate tenant data backup Initiate tenant data backup.
Backup and Recovery Create tenant backup strategy Creates a tenant backup strategy.
Backup and Recovery Delete tenant backup strategy Delete tenant backup strategy.
Backup and Recovery View tenant data backup tasks View tenant data backup tasks.
Backup and Recovery View tenant log backup tasks View tenant log backup tasks.
Backup and Recovery View a restore task View the restore task.
Backup and Recovery Parse tenant backup information Parse tenant backup information.
Backup and Recovery Query tenant backup strategy Query tenant backup policies.
Backup and Recovery Update tenant backup strategy Updates the tenant backup strategy.
Backup and Recovery Start tenant backup scheduling Start tenant backup scheduling.
Backup and Recovery Pause tenant backup scheduling Suspends tenant backup scheduling.
Backup and Recovery Parse global backup information Access the specified backup storage using the host managed by the current OCP, and parse the source cluster, source tenant, and recoverable time interval from it.
Backup and Recovery Global Initiate Tenant Recovery Initiate tenant restore from the global view, where the source cluster does not need to be managed by the current OCP.

Host management APIs

Module
API name
Description
Host Module Query the region list Query the list of region information.
Host Module Query area details Query host region information by region ID.
Host Module Add a region Add host region information.
Host Module Delete region information Delete region information.
Host Module Query the data center list Query the IDC information list.
Host Module Query detailed data center information Query host IDC information by IDC ID.
Host Module Add data center information Add host IDC information.
Host Module Delete IDC information Delete IDC information.
Host Module Query model list Query the list of instance types.
Host Module Query model details Query host IDC information by instance ID.
Host Module Add new model information Add host model information.
Host Module Delete model information Delete the model information.
Host Module Query host list Query the host information list.
Host Module Query host details Query host details by host ID.
Host Module Add hosts in batches Add host information in batches.
Host Module Delete host Delete host information.
Host Module Delete multiple hosts Batch delete host information.

Software package API list

Module
API name
Description
Software Package API Query the software package list Query the software package information managed by OCP. You can filter the package list by keyword, type, version, operating system, and architecture, or sort the list by upload time.
Software Package API Upload a software package Upload local software packages to the OCP server. You can filter the package list by keyword, type, version, operating system, and architecture, or sort the list by upload time.
Software Package API Delete software packages Deletes specified software package information.

List of O&M task management APIs

Module
API name
Description
Task Management Query the task list Query the task list, which supports filtering by different parameters.
Task Management Query task details This API is used to query the details of a task execution.
Task Management Retry a task Triggers the re-execution of all failed subtasks of a task.
Task Management Rollback tasks Roll back from all failed subtask nodes.
Task Management Query subtask instance logs Query the log information of a subtask by its instance ID. Log information is automatically refreshed for ongoing subtasks when queried multiple times.
Task Management Retry a subtask Rerun failed subtasks.
Task Management Skip a subtask Skip the failed subtask and mark it as successful.
Task Management Cancel a subtask Aborts the execution of the subtask and marks it as failed.

System management APIs

Module
API name
Description
Health Check Query the basic information of an OCP application Query the basic information of an OCP application, including: version number, build date, Java version, and other details.
Health Check Query the OCP server time Query the time on the OCP server. This API is generally used to confirm whether the local time is synchronized with the server time.
Health Check Query the status of OCP applications Query the status of OCP applications. This API checks the status of each module in the OCP application and returns whether all statuses are healthy.
Operation Audit Query historical events Query historical events in OCP. You can filter historical events by event type, operation event name, resource name, operator ID, event information, event status, or the time period when the event occurred.
Agent Management Query the details of the OCP agent on a host Retrieves detailed information about the OCP Agent on a specified host.
Agent Management Stop the underlying process of the OCP agent on a host Stop the OCP Agent base process on the specified host.
Agent Management Stop the basic processes of the OCP Agent on multiple hosts in batches Stop the basic processes of the OCP Agent on hosts in batches.
Agent Management Restart the basic process of the OCP Agent on the host Restart the base process of the OCP Agent on the specified host.
Agent Management Batch restart the basic processes of the OCP Agent on hosts Batch restart the base processes of the OCP Agent on hosts.
Agent Management Query the OCP Agent process list on a host Query the worker process list of the OCP Agent on the host.
Agent Management Restart the worker process of the OCP agent on a host The worker process of the OCP Agent on the specified host during restart.
Agent Management Stop the worker processes of the OCP agent on the host Stop the OCP Agent worker process on the specified host.

SOP API List

Module
API Name
Description
SOP Task Management Query SOP Type List Queries the list of available SOP types, including their names, target input prompts, and prerequisites.
SOP Task Management Query Default Steps of a Specified Type Queries the default step template of a specified SOP type.
SOP Task Management Create an SOP Task Creates an SOP task definition.
SOP Task Management Query SOP Tasks Queries tasks that can be read by callers by name, type, or display status. Supports pagination and sorting.
SOP Task Management Query SOP Task Details Queries the task definition, target parameters, step configuration, and derived status.
SOP Task Management Edit an SOP Task Fully updates the name, target parameters, step configuration, and remarks of an unstarted task.
SOP Task Management Start an SOP Task Creates an execution instance and all enabled steps, and starts the first step.
SOP Task Management Delete an SOP Task Deletes an SOP task.
SOP Task Management Query SOP Execution Details Queries the task execution status and the status of all steps.
SOP Task Management Execute Next Step Advances the current ready step whose autoRun attribute is set to false.
SOP Task Management Retry All Failed Steps Retries all failed steps when the overall execution instance status is FAILED.
SOP Task Management Retry a Specified Failed Step Retries a specified failed step.
SOP Task Management Update the Auto-Execution Switch or Step Parameters of Unexecuted Steps Updates steps in a started task that are in the PENDING state.

Others

Name
Description
API details This topic describes how to call the open APIs of OCP using HTTP.
AK/SK Signature Generation Rules This topic describes the signature generation rules for AK and SK.
Task return structure This topic describes the data structure of the response parameters in a task.
Alert API Integration Example Describes how to integrate OCP alerts with your alerting platform.

Previous topic

Handling alert responses
Last

Next topic

API call description
Next
on this page
List of cluster management APIs
Tenant management APIs
OBProxy Management API List
Database management APIs
Monitoring APIs
Alert API List
Inspection API List
SQL Performance API List
Backup and Recovery APIs
Host management APIs
Software package API list
List of O&M task management APIs
System management APIs
SOP API List
Others