OceanBase Cloud provides the following Open APIs. Before using them, you must prepare an identity account and an AccessKey. For more information, see Manage AccessKeys.
Click to download the OceanBase Cloud OpenAPI file Cluster management
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| DescribeInstances | Query cluster list | Query the list of OceanBase clusters. |
| DescribeInstance | Query cluster information | Query detailed information about an OceanBase cluster. |
| CreateInstance | Create cluster | Create an OceanBase cluster instance. |
| DeleteInstance | Delete cluster | Delete an OceanBase cluster instance. |
| ModifyInstanceName | Modify cluster name | Modify the cluster name of OceanBase. |
| DescribeNodeOptions | Query cluster node information | Query the cluster node information of OceanBase. |
| StopCluster | Pause a cluster instance | Pause an OceanBase cluster instance. |
| StartCluster | Start a cluster instance | Start an OceanBase cluster instance. |
| ModifyInstanceSpec | Modify cluster specifications | Modify the cluster specifications of OceanBase. |
| DescribeInstanceTopology | Query the topology information of an instance | Query the topology information of an instance. |
| DescribeReadonlyInstances | Query instance read-only replica information | Query the basic information of a read-only replica instance. |
| CreateReadonlyInstance | Create a read-only replica instance | Create a read-only replica instance. |
| ModifyReadonlyInstanceSpec | Modify the specification of a read-only replica instance | Modify the instance specification of a read-only replica. |
| ModifyReadonlyInstanceDiskSize | Modify the disk size of a read-only replica | Modify the instance specification of a read-only replica. |
| ModifyReadonlyInstanceNodeNum | Modify the number of read-only replica nodes | Modify the number of nodes in a read-only replica. |
| DeleteReadonlyInstance | Delete a read-only replica instance | Delete a read-only replica instance. |
| DescribeInstanceAvailableRoZones | Query the zone of a read-only replica | Query the zone of a read-only replica. |
| DescribeInstanceparameters | Query cluster-level parameters | Query cluster-level parameters. |
| UpdateInstanceParameters | Modify cluster-level parameters | Modify cluster-level parameters. |
| DescribeInstanceparametersHistory | Query the modification history of cluster-level parameters | Query the modification history of cluster-level parameters. |
| ModifyInstanceTagList | Modify instance tags | Instance tag modification. |
| ModifyInstanceNodeNum | Modify the number of cluster nodes | Modify the number of cluster nodes. |
| DescribeInstanceAnomalyEvents | Query instance anomaly events | Query exception events that occurred in a specified instance within a specified time period. |
| DescribeOasClusterAnomalySqlList | Query suspicious SQL statements in a cluster | Query the list of suspicious SQL statements for a specified instance within a specified time period. |
| DescribeOasClusterSlowSQLList | Query slow SQL statements in a cluster | Query the list of slow SQL statements for a specified instance within a specified time range. |
| SwitchoverInstance | Perform a primary/standby switchover | Promote the specified standby instance to the primary instance. |
Tenant management
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| DescribeTenants | Query tenant list information in a cluster | Query the list of tenants in a cluster. |
| DescribeTenant | Query information of a specified tenant in a specified cluster | Query the information of a specified tenant in a specified cluster. |
| CreateTenants | Create tenant | Create a tenant. |
| DeleteTenants | Delete tenant | Delete one or more tenants from a specified OceanBase cluster. |
| ModifyTenantName | Modify tenant name | Modify the name of a tenant in a specified OceanBase cluster. |
| ModifyTenant | Modify tenant | Modify the tenant information under a specified OceanBase cluster. |
| ModifyTenantUserDescription | Modify tenant user description | Modify the tenant user description. |
| ModifyTenantUserStatus | Modify tenant user status | Modify the tenant user status. |
| GetTenantCreateConstraints | Query constraints for creating a tenant | Query the constraints for creating a tenant in a specified OceanBase cluster. |
| ModifyTenantPrimaryZone | Modify the primary zone of a tenant | Modify the primary zone of a tenant. |
| GetTenantCreateCpuConstraints | Query CPU constraints for tenant creation | Query the CPU constraints for creating tenants in a specified OceanBase cluster. |
| GetTenantCreateMemConstraints | Query memory constraints for creating a tenant | Query the memory constraints for creating a tenant in a specified OceanBase cluster. |
| GetTenantModifyCpuConstraints | Query the CPU constraints for modifying a tenant | Query the CPU constraints for modifying tenants in a specified OceanBase cluster. |
| GetTenantModifyMemConstraints | Query memory constraints for modifying a tenant | Query the memory constraints for modifying tenants in a specified OceanBase cluster. |
| CreateTenantSecurityIpGroup | Create tenant security allowlist information | Creates tenant security allowlist information. |
| DescribeTenantSecurityIpGroups | Query tenant allowlist group list | Query the tenant allowlist group list. |
| ModifyTenantSecurityIpGroup | Modify tenant allowlist group information | Modify the tenant allowlist group information. |
| DeleteTenantSecurityIpGroup | Delete tenant allowlist group information | Delete tenant allowlist group information. |
| DescribeTenantPrivateLink | Query tenant connection information | Query the connection information of a tenant. |
| DeletePrivatelinkConnection | Delete tenant connection address | Delete tenant connection address. |
| CreatePrivatelinkService | Enable tenant connection | Enable PrivateLink connection for the tenant. |
| ConnectPrivatelinkService | Connect to a database through a PrivateLink endpoint | Connect to the database through a PrivateLink endpoint. |
| AddPrivatelinkServiceUser | Add user to allowlist | Add users to the allowlist. |
| BatchKillProcessList | Batch terminate session processes of a specified tenant | Terminates the session processes of a specified tenant in batches. |
| DescribeProcessStatsComposition | Query session process statistics | Query session process statistics. |
| DescribeTenantAddressInfo | Query tenant address information | Query tenant address information in a specified cluster. |
| DescribeTenantAvailableRoZones | Query tenant read-only replicas | Query the basic information of tenant read-only replicas. |
| ModifyTenantReadonlyReplica | Modify tenant read-only replica | Modify tenant read-only replicas. |
| DescribeTenantParameters | Query tenant-level parameters | Query tenant-level parameters. |
| UpdateTenantParameters | Modify tenant-level parameters | Modify tenant-level parameters. |
| DescribeTenantParametersHistory | Query tenant-level parameter modification history | Query the modification history of tenant-level parameters. |
| ModifyTenantTagList | Modify tenant tag | Tenant tag modification. |
| CreateReadonlyPrivatelink | Create private network read-only endpoints for a tenant | Creates a private network read-only endpoint for a tenant under the specified instance, suitable for scenarios where read and write traffic are separated. |
| CreateReadwritePrivatelink | Create a private network read/write separation endpoint for a tenant | Creates a private network read/write splitting endpoint for a tenant under the specified instance, distributing read and write requests to different nodes to enhance concurrent processing capabilities. |
Tenant account management
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| CreateTenantUser | Create tenant user | Create an account to access the database under the specified tenant. |
| DescribeTenantUsers | Query tenant account list | Query the list of accounts that access all databases in a tenant. |
| DeleteTenantUsers | Delete tenant user | Delete one or more database accounts. |
| ModifyTenantUserPassword | Change tenant user password | Modify the login password of a specified database account in a tenant. |
| ModifyTenantUserRoles | Modify tenant user role | Modify the role of a specified database account under a tenant. |
Database management
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| CreateDatabase | Create a database | Creates a new database under the specified tenant. |
| DescribeDatabases | Query the database list | Query the database list. |
| DeleteDatabases | Delete database | Delete one or more created databases. |
| ModifyDatabaseUserRoles | Modify database user role | Modify the database user role. |
| DescribeTableSchema | Query table schema | Query the schema information of a specified data table under a specified tenant in a specified instance. |
Backup and recovery
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| DescribeDataBackupSet | Query data backup set information | Query data backup set information. |
| DescribeRestorableTenants | Query restorable tenants | Query recoverable tenants. |
| ModifyBackupStrategy | Modify backup strategy | Modify the backup strategy. |
| CreateTenantRestoreTask | Create tenant restore task | Creates a tenant restore task. |
| CreateDataBackupTask | Create backup task | Create a backup task. |
| DescribeOneDataBackupSet | Query backup set details by task ID | Query backup set details by task ID. |
| DescribeBackupStrategy | Query backup strategy | Query the backup strategy configuration details of a specified OceanBase Cloud database instance. |
| CreateBackupSetDownloadLink | Create backup set download link | Create a download link for a backup set of the specified OceanBase Cloud database instance. |
| DescribeBackupSetDownloadLink | Query backup set download link | Query the details of a backup set download task for a specified OceanBase Cloud database instance. |
Database proxy management
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| CreateTenantAddress | New tenant address | This API is used to create a tenant address. |
| CreateTenantSingleTunnelSLBAddres | Create tenant singleTunnelSLB address | This API is used to create a singleTunnelSLB endpoint for a tenant. |
| DeleteTenantAddress | Delete tenant address | This API is used to delete a tenant address. |
| DescribeTenantAddress | Query tenant address | This API is used to query the tenant address. |
| ModifyOdpClusterSpec | Modify the database proxy cluster specification | This API is used to change the database proxy cluster specification. |
| ModifyTenantAddressPort | Modify tenant address port | This API is used to modify the tenant address port. |
| ModifyTenantAddressDomainPrefix | Modify tenant address domain name prefix | This API is used to modify the tenant address domain name prefix. |
| ConfirmPrivatelinkConnection | Confirm Private Link connection | This API is used to confirm the completion of a Private Link connection. |
| DescribeTenantAddressInfo | Query all tenant address information | Query the address information of all tenants. |
Monitoring management
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| DescribeTenantMetrics | Query tenant metrics | Query the metrics of a specified OceanBase tenant. |
| DescribeMetricsData | Query monitoring metric data | Query single-dimensional or multi-dimensional monitoring metric data for an OceanBase cluster. |
| DescribeNodeMetrics | Query node metrics | Query the metrics of an OceanBase node. |
| CreatePrometheusIntegration | Create a Prometheus monitoring integration | Creates a Prometheus monitoring integration for the specified OceanBase Cloud database instance and generates a Prometheus scrape target configuration file. |
| DeletePrometheusIntegration | Delete Prometheus monitoring integration | Delete a configured Prometheus monitoring integration to stop collecting monitoring metrics for the corresponding instance. |
| ListPrometheusIntegration | Query Prometheus monitoring integration list | Query the list of configured Prometheus monitoring integrations in the current project. |
Diagnostic management
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| DescribeOasTopSQLList | Query the TopSQL list | Query the list of SQL execution performance data collected by the diagnostic system. |
| DescribeOasAnomalySQLList | Query suspicious SQL statements | Query the diagnostic system for a list of SQL statements that may have performance issues. |
| DescribeOasSlowSQLList | Query the SlowSQL list | Query the slow SQL list. |
| DescribeSqlAudits | Query SQL audit information | Query an OceanBase SQL audit information. |
| DescribeOasSQLText | Query SQL text | Query the text information of an OceanBase SQL statement. |
| DescribeOutlineBinding | Query SQL outline binding information | Query SQL outline binding information. |
| DescribeSampleSqlRawTexts | Query SQL raw text samples | Query SQL raw text samples. |
| DescribeSQLTuningAdvices | SQL query tuning suggestions | Query SQL tuning suggestions. |
| DescribeOasSlowSQLSamples | Query slow SQL execution details sample data | Query the sampled data of slow SQL execution details. |
| DescribeOasSQLTrends | Query SQL execution history | Query the SQL execution history data. |
| DescribeOasSQLPlanGroup | Query SQL execution plan | Query the SQL execution plan. |
| DescribeRcaRecord | Query root cause analysis records | Query the root cause analysis results of an exception on a specified instance. |
| DescribeTopSQLComparision | SQL execution comparison | Compare the performance data of top SQL statements between the specified time period and the baseline time period. |
| DescribeSessionStatsGroupBySqlId | Aggregate session statistics by SQL ID | Query the statistics of all sessions in a specified instance and tenant, grouped by SQL ID. |
| DescribeIndexes | Query index information | Query the index information of a specific database and table in a specified instance and tenant. |
| DescribeOasHighRiskSQL | Query high-risk SQL | Query high-risk SQL statements for a specified instance and tenant within a specific time period. |
Security management
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| CreateSecurityIpGroup | Create instance allowlist group | Create an instance allowlist group. |
| DescribeInstanceSSL | Query SSL configuration information of an instance | Query the SSL configuration information of an instance. |
| ModifyInstanceSSL | Modify the SSL configuration of an instance | Modify the SSL configuration of an instance. |
| DescribeTenantEncryption | Query tenant encryption information | Query tenant encryption information. |
| ModifyTenantEncryption | Enable transparent data encryption for a tenant | Enable transparent data encryption for a tenant. |
| ModifySecurityIps | Modify the IP list in the instance allowlist | Modify the IP list in the instance's allowlist. |
| DeleteSecurityIpGroup | Delete instance allowlist group | Delete an instance from an allowlist group. |
| DescribeTenantSecurityConfigs | Tenant security configuration check | Detects tenant security configurations and returns the detection results and risk items for each tenant. |
| DescribeInstanceSecurityConfigs | Cluster security configuration check | Detects the security configuration of a cluster and returns the detection results and risk items at the cluster level. |
Tag management
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| DescribeTags | Query tag list | Query the tag list of the current organization and return the tag keys and their corresponding value sets. |
| CreateTags | Batch create tags | Batch create tags in the current organization. |
| UpdateTag | Update tag | Updates the key and value of a specified tag. |
| DeleteTag | Delete tag | Delete the specified tag. |
Historical event management
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| DescribeOperationEvents | Get historical events | Query historical event information. |
AI services
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| CreateAIServiceAPIKey | Create an AI API key | Create a new AI API Key. |
| DeleteAIServiceAPIKey | Delete AI API key | Delete an API key under a specified project based on its unique identifier (UUID). |
| ListAIServiceAPIKeys | Query API key list | Query the list of API keys under a specified organization and project in pagination mode. |
Data source management
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| ListDataSources | List data sources | Queries data sources in the current project. |
| CreateDataSource | Create a data source | Creates a data source configuration. |
| DeleteDataSource | Delete a data source | Deletes the specified data source. |
OMS project management
Open API |
Title |
Overview of Open APIs |
|---|---|---|
| CreateProject | Create a project | Creates a data migration or synchronization project. |
| DeleteProject | Delete a project | Deletes the specified OMS project. |
| DescribeProject | Query project details | Queries details of an OMS project. |
| DescribeProjectSteps | Query project steps | Queries the execution steps of a project. |
| StartProject | Start a project | Starts the specified OMS project. |
| StopProject | Stop a project | Stops a running OMS project. |
| ResumeProject | Resume a project | Resumes a suspended OMS project. |
| ReleaseProject | Release project resources | Releases the resources of a data migration or synchronization project. |
| UpdateProjectConfig | Update project configuration | Updates the configuration of an OMS project. |
| ListProjectModifyRecords | List project modification records | Queries modification records for an OMS project. |
| CreateProjectModifyRecords | Create modification records in a batch | Creates OMS project modification records in a batch. |
| CancelProjectModifyRecord | Cancel a modification record | Cancels the specified project modification record. |
| RetryProjectModifyRecords | Retry a modification | Retries a modification by modification record ID. |
| StopProjectModifyRecords | Terminate a modification | Terminates a modification that is in progress. |
| GetModifyRecord | Query modification record details | Queries details by modification record ID. |
| DescribeTransferMapping | Query transfer object mappings | Queries the transfer object mappings of a project. |