Currently, you can use the following Open APIs of OceanBase Cloud. Before you use an Open API, you must prepare an identity account and an AccessKey. For more information, see Manage AccessKeys.
Cluster management
| Open API | Title | Description |
|---|---|---|
| DescribeInstances | Get cluster list | Query the list of OceanBase clusters. |
| DescribeInstance | Get cluster information | Query the details of 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 name of an OceanBase cluster. |
| DescribeNodeOptions | Query cluster node information | Query the node information of an OceanBase cluster. |
| StopCluster | Suspend cluster instance | Suspend an OceanBase cluster instance. |
| StartCluster | Start cluster instance | Start an OceanBase cluster instance. |
| ModifyInstanceSpec | Modify cluster specification | Modify the specification of an OceanBase cluster. |
| DescribeInstanceTopology | Query instance topology information | Query the topology information of an instance. |
| DescribeReadonlyInstances | Get information about read-only replicas | Query the basic information of read-only replicas. |
| 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 specification of a read-only replica instance. |
| ModifyReadonlyInstanceDiskSize | Modify the disk size of a read-only replica | Modify the disk size of a read-only replica. |
| ModifyReadonlyInstanceNodeNum | Modify the number of nodes in a read-only replica | 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 available zones of read-only replicas | Query the available zones of read-only replicas. |
Tenant management
| Open API | Title | Description |
|---|---|---|
| DescribeTenants | Query the list of tenants in a cluster | Queries the list of tenants in a cluster. |
| DescribeTenant | Query the information about a tenant in a specified cluster | Queries the information about a tenant in a specified cluster. |
| CreateTenants | Create a tenant | Creates a tenant. |
| DeleteTenants | Delete a tenant | Deletes one or more tenants in the specified OceanBase cluster. |
| ModifyTenantName | Modify the name of a tenant | Modifies the name of a tenant in the specified OceanBase cluster. |
| ModifyTenant | Modify a tenant | Modifies the information about a tenant in the 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 the 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 the specified OceanBase cluster. |
| GetTenantCreateMemConstraints | Query the memory constraints for creating a tenant | Queries the memory constraints for creating a tenant in the specified OceanBase cluster. |
| GetTenantModifyCpuConstraints | Query the CPU constraints for modifying a tenant | Queries the CPU constraints for modifying a tenant in the specified OceanBase cluster. |
| GetTenantModifyMemConstraints | Query the memory constraints for modifying a tenant | Queries the memory constraints for modifying a tenant in the 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 groups of a tenant | Modifies the allowlist groups of a tenant. |
| DeleteTenantSecurityIpGroup | Delete the allowlist groups of a tenant | Deletes the allowlist groups 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 | Batch terminate sessions of a specified tenant | Batch terminates sessions of a specified tenant. |
| DescribeProcessStatsComposition | Query the statistics of sessions | Queries the statistics of sessions. |
| 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. |
Tenant account management
| Open API | Title | Description |
|---|---|---|
| CreateTenantUser | Create a tenant user | You can call this API to create an account for accessing a database in a specified tenant. |
| DescribeTenantUsers | Query the list of tenant accounts | You can call this API to query the list of accounts for accessing a database in a specified tenant. |
| DeleteTenantUsers | Delete a tenant user | You can call this API to delete one or more database accounts. |
| ModifyTenantUserPassword | Modify the password of a tenant user | You can call this API to modify the login password of a database account in a specified tenant. |
| ModifyTenantUserRoles | Modify the roles of a tenant user | You can call this API to modify the roles of a database account in a specified tenant. |
Database management
| Open API | Title | Description |
|---|---|---|
| CreateDatabase | Create a database | You can call this API to create a new database in a specified tenant. |
| DescribeDatabases | Query the list of databases | You can call this API to query the list of databases. |
| DeleteDatabases | Delete a database | You can call this API to delete one or more created databases. |
| ModifyDatabaseUserRoles | Modify the roles of a database user | You can call this API to modify the roles of a database user. |
Backup and restore
| Open API | Title | Description |
|---|---|---|
| DescribeDataBackupSet | Query data backup sets | You can call this API to query data backup sets. |
Database proxy management
| Open API | Title | Description |
|---|---|---|
| CreateTenantAddress | Create a tenant address | You can call this API to create a tenant address. |
| CreateTenantSingleTunnelSLBAddres | Create a tenant singleTunnelSLB address | You can call this API to create a tenant singleTunnelSLB address. |
| DeleteTenantAddress | Delete a tenant address | You can call this API to delete a tenant address. |
| DescribeTenantAddress | Query a tenant address | You can call this API to query a tenant address. |
| ModifyOdpClusterSpec | Modify the specifications of a database proxy cluster | You can call this API to modify the specifications of a database proxy cluster. |
| ModifyTenantAddressPort | Modify the port of a tenant address | You can call this API to modify the port of a tenant address. |
| ModifyTenantAddressDomainPrefix | Modify the domain prefix of a tenant address | You can call this API to modify the domain prefix of a tenant address. |
| ConfirmPrivatelinkConnection | Confirm the completion of a Private Link connection | You can call this API to confirm the completion of a Private Link connection. |
Monitoring management
| Open API | Title | Description |
|---|---|---|
| DescribeTenantMetrics | Query tenant metrics | Queries the metrics of the specified OceanBase tenant. |
| DescribeMetricsData | Query metrics data | Queries the metrics of the specified OceanBase cluster. |
Diagnostic management
| Open API | Title | Description |
|---|---|---|
| DescribeOasTopSQLList | Query TopSQL list | Queries the list of SQL execution performance data collected by the diagnostic system. |
| DescribeOasAnomalySQLList | Query suspicious SQL list | Queries the list of SQL statements that may have performance issues. |
| DescribeOasSlowSQLList | Query SlowSQL list | Queries the list of slow SQL statements. |
| DescribeSqlAudits | Query SQL audit information | Queries the SQL audit information of an OceanBase cluster. |
| DescribeOasSQLText | Query SQL text | Queries the SQL text of an OceanBase cluster. |
| DescribeOutlineBinding | Query SQL outline binding information | Queries the SQL outline binding information. |
| DescribeSampleSqlRawTexts | Query SQL raw text samples | Queries the SQL raw text samples. |
| DescribeSQLTuningAdvices | Query SQL tuning suggestions | Queries the SQL tuning suggestions. |
Security management
| Open API | Title | Description |
|---|---|---|
| CreateSecurityIpGroup | Create security IP group | Creates a security IP group. |
| DescribeInstanceSSL | Query instance SSL configuration | Queries the SSL configuration of an instance. |
| ModifyInstanceSSL | Modify instance SSL configuration | Modifies the SSL configuration of an instance. |
Historical events management
| Open API | Title | Description |
|---|---|---|
| DescribeOperationEvents | Get historical events | Query historical events. |