Currently, OceanBase Cloud provides the following APIs. Before you use an API, you must prepare an identity account and an AccessKey. For more information, see Manage AccessKeys.
Cluster management
| Open API | Title | Open API Overview |
|---|---|---|
| DescribeInstances | Get cluster list | Queries the list of OceanBase clusters. |
| DescribeInstance | Get cluster information | Queries the details of an OceanBase cluster. |
| CreateInstance | Create cluster | Creates an OceanBase cluster instance. |
| DeleteInstance | Delete cluster | Deletes an OceanBase cluster instance. |
| ModifyInstanceName | Modify cluster name | Modifies the name of an OceanBase cluster. |
| DescribeNodeOptions | Query cluster node information | Queries the node information of an OceanBase cluster. |
| StopCluster | Suspend cluster instance | Suspends an OceanBase cluster instance. |
| StartCluster | Start cluster instance | Starts an OceanBase cluster instance. |
| ModifyInstanceSpec | Modify cluster specification | Modifies the specification of an OceanBase cluster. |
| DescribeInstanceTopology | Query instance topology information | Queries the topology information of an instance. |
| DescribeReadonlyInstances | Get instance read-only replica information | Queries the basic information of a read-only replica instance. |
| CreateReadonlyInstance | Create read-only replica instance | Creates a read-only replica instance. |
| ModifyReadonlyInstanceSpec | Modify read-only replica instance specification | Modifies the specification of a read-only replica instance. |
| ModifyReadonlyInstanceDiskSize | Modify read-only replica disk size | Modifies the disk size of a read-only replica instance. |
| ModifyReadonlyInstanceNodeNum | Modify read-only replica node number | Modifies the number of nodes of a read-only replica. |
| DeleteReadonlyInstance | Delete read-only replica instance | Deletes a read-only replica instance. |
| DescribeInstanceAvailableRoZones | Query read-only replica zones | Queries the zones of a read-only replica. |
| DescribeInstanceparameters | Query cluster-level parameters | Queries cluster-level parameters. |
| UpdateInstanceParameters | Modify cluster-level parameters | Modifies cluster-level parameters. |
| DescribeInstanceparametersHistory | Query cluster-level parameter modification history | Queries the modification history of cluster-level parameters. |
| ModifyInstanceTagList | Modify instance tags | Modifies instance tags. |
| ModifyInstanceNodeNum | Modify the number of cluster nodes | Modifies the number of cluster nodes. |
Tenant management
| Open API | Title | Open API Overview |
|---|---|---|
| DescribeTenants | Query the list of tenants in a cluster | Queries the list of tenants in a cluster. |
| DescribeTenant | Query the information of a specified tenant in a specified cluster | Queries the information of a specified tenant in a specified cluster. |
| CreateTenants | Create a tenant | Creates a tenant. |
| DeleteTenants | Delete a tenant | Deletes one or more tenants in a specified OceanBase cluster. |
| ModifyTenantName | Modify the name of a tenant | Modifies the name of a tenant in a specified OceanBase cluster. |
| ModifyTenant | Modify a tenant | Modifies the information of a tenant in a specified OceanBase cluster. |
| ModifyTenantUserDescription | Modify the description of a tenant user | Modifies the description of a tenant user. |
| ModifyTenantUserStatus | Modify the status of a tenant user | Modifies the status of a tenant user. |
| GetTenantCreateConstraints | Query the constraints for creating a tenant | Queries the constraints for creating a tenant in a specified OceanBase cluster. |
| ModifyTenantPrimaryZone | Modify the primary zone of a tenant | Modifies the primary zone of a tenant. |
| GetTenantCreateCpuConstraints | Query the CPU constraints for creating a tenant | Queries the CPU constraints for creating a tenant in a specified OceanBase cluster. |
| GetTenantCreateMemConstraints | Query the memory constraints for creating a tenant | Queries the memory constraints for creating a tenant in a specified OceanBase cluster. |
| GetTenantModifyCpuConstraints | Query the CPU constraints for modifying a tenant | Queries the CPU constraints for modifying a tenant in a specified OceanBase cluster. |
| GetTenantModifyMemConstraints | Query the memory constraints for modifying a tenant | Queries the memory constraints for modifying a tenant in a specified OceanBase cluster. |
| CreateTenantSecurityIpGroup | Create a security allowlist for a tenant | Creates a security allowlist for a tenant. |
| DescribeTenantSecurityIpGroups | Query the allowlist groups of a tenant | Queries the allowlist groups of a tenant. |
| ModifyTenantSecurityIpGroup | Modify the allowlist group of a tenant | Modifies the allowlist group of a tenant. |
| DeleteTenantSecurityIpGroup | Delete the allowlist group of a tenant | Deletes the allowlist group of a tenant. |
| DescribeTenantPrivateLink | Query the connection information of a tenant | Queries the connection information of a tenant. |
| DeletePrivatelinkConnection | Delete the connection address of a tenant | Deletes the connection address of a tenant. |
| CreatePrivatelinkService | Enable the connection of a tenant | Enables the PrivateLink connection for a tenant. |
| ConnectPrivatelinkService | Connect to a database through a PrivateLink endpoint | Connects to a database through a PrivateLink endpoint. |
| AddPrivatelinkServiceUser | Add a user to the allowlist | Adds a user to the allowlist. |
| BatchKillProcessList | Terminate the sessions of a specified tenant | Terminates the sessions of a specified tenant. |
| DescribeProcessStatsComposition | Query the statistics of sessions | Queries the statistics of sessions. |
| DescribeTenantAddressInfo | Query the address information of a tenant | Queries the address information of a tenant in a specified cluster. |
| DescribeTenantAvailableRoZones | Query the basic information about the read-only replicas of a tenant | Queries the basic information about the read-only replicas of a tenant. |
| ModifyTenantReadonlyReplica | Modify the read-only replicas of a tenant | Modifies the read-only replicas of a tenant. |
| DescribeTenantParameters | Query the tenant-level parameters | Queries the tenant-level parameters. |
| UpdateTenantParameters | Modify the tenant-level parameters | Modifies the tenant-level parameters. |
| DescribeTenantParametersHistory | Query the modification history of tenant-level parameters | Queries the modification history of tenant-level parameters. |
Tenant account management
| Open API | Title | Open API Overview |
|---|---|---|
| CreateTenantUser | Create a tenant user | Creates a database account in the specified tenant. |
| DescribeTenantUsers | Query a tenant account list | Queries the list of database accounts in a tenant. |
| DeleteTenantUsers | Delete a tenant user | Deletes one or more database accounts. |
| ModifyTenantUserPassword | Modify a tenant user password | Modifies the login password of a database account in the specified tenant. |
| ModifyTenantUserRoles | Modify a tenant user role | Modifies the role of a database account in the specified tenant. |
Database management
| Open API | Title | Open API Overview |
|---|---|---|
| CreateDatabase | Create a database | Creates a new database in the specified tenant. |
| DescribeDatabases | Query a database list | Queries the database list. |
| DeleteDatabases | Delete a database | Deletes one or more created databases. |
| ModifyDatabaseUserRoles | Modify a database user role | Modifies the role of a database user. |
Backup and restore
| Open API | Title | Open API Overview |
|---|---|---|
| DescribeDataBackupSet | Query data backup set information | Queries data backup set information. |
| DescribeRestorableTenants | Query a restorable tenant | Queries a restorable tenant. |
Database proxy management
| Open API | Title | Open API Overview |
|---|---|---|
| CreateTenantAddress | Create a tenant address | Creates a tenant address. |
| CreateTenantSingleTunnelSLBAddres | Create a tenant singleTunnelSLB address | Creates a tenant singleTunnelSLB address. |
| DeleteTenantAddress | Delete a tenant address | Deletes a tenant address. |
| DescribeTenantAddress | Query a tenant address | Queries a tenant address. |
| ModifyOdpClusterSpec | Change the specifications of a database proxy cluster | Changes the specifications of a database proxy cluster. |
| ModifyTenantAddressPort | Modify a tenant address port | Modifies a tenant address port. |
| ModifyTenantAddressDomainPrefix | Modify a tenant address domain prefix | Modifies a tenant address domain prefix. |
| ConfirmPrivatelinkConnection | Confirm a Private Link connection | Confirms a Private Link connection. |
| DescribeTenantAddressInfo | Query all tenant address information | Queries all tenant address information. |
Monitoring management
| Open API | Title | Open API Overview |
|---|---|---|
| DescribeTenantMetrics | Query tenant metrics | Queries the metrics of an OceanBase tenant. |
| DescribeMetricsData | Query monitoring metrics data | Queries the single- or multi-dimensional monitoring metrics data of an OceanBase cluster. |
Diagnostic management
| Open API | Title | Open API Overview |
|---|---|---|
| DescribeOasTopSQLList | Query TopSQL list | Queries the list of SQL execution performance data collected by the diagnostic system. |
| DescribeOasAnomalySQLList | Query the list of suspicious SQL statements | Queries the list of SQL statements that may have performance issues, as determined by the diagnostic system. |
| DescribeOasSlowSQLList | Query the list of slow SQL statements | Queries the list of slow SQL statements. |
| DescribeSqlAudits | Query SQL audit information | Queries the SQL audit information of an OceanBase Database instance. |
| DescribeOasSQLText | Query SQL text | Queries the SQL text of an OceanBase Database instance. |
| DescribeOutlineBinding | Query SQL outline binding information | Queries the SQL outline binding information. |
| DescribeSampleSqlRawTexts | Query sample SQL raw text | Queries sample SQL raw text. |
| DescribeSQLTuningAdvices | Query SQL tuning suggestions | Queries SQL tuning suggestions. |
| DescribeOasSlowSQLSamples | Query sampling data of slow SQL execution details | Queries sampling data of slow SQL execution details. |
| DescribeOasSQLTrends | Query SQL execution history | Queries SQL execution history. |
| DescribeOasSQLPlanGroup | Query SQL execution plan | Queries the SQL execution plan. |
Security management
| Open API | Title | Open API Overview |
|---|---|---|
| CreateSecurityIpGroup | Create a security IP group | Creates a security IP group. |
| DescribeInstanceSSL | Query the SSL configuration of an instance | Queries the SSL configuration of an instance. |
| ModifyInstanceSSL | Modify the SSL configuration of an instance | Modifies the SSL configuration of an instance. |
| describetenantcryption | Query tenant encryption information | Queries the tenant encryption information. |
| ModifyTenantEncryption | Enable tenant transparent encryption | Enables tenant transparent encryption. |
| ModifySecurityIps | Modify the IP list in the instance allowlist | Modifies the IP list in the instance allowlist. |
| CreateSecurityIpGroup | Create an instance allowlist group | Creates an instance allowlist group. |
| DeleteSecurityIpGroup | Delete an instance allowlist group | Deletes an instance allowlist group. |
Historical events management
| Open API | Title | Open API Overview |
|---|---|---|
| DescribeOperationEvents | Query historical events | Queries the information about historical events. |
