OceanBase Cloud currently provides the following open APIs. Before you use an open API, you must obtain an identity account and an accesskey. For more information, see Manage AccessKey pairs.
Instance management
| Open API | Title | Open API description |
|---|---|---|
| DescribeInstances | Get instance list | Query the list of OceanBase instances. |
| DescribeInstance | Get instance details | Query the details of a specific OceanBase instance. |
| CreateInstance | Create an instance | Create an OceanBase instance. |
| DeleteInstance | Delete an instance | Delete an OceanBase instance. |
| ModifyInstanceName | Modify instance name | Modify the name of an OceanBase instance. |
| DescribeNodeOptions | Query node information | Query the information about OceanBase nodes. |
| StopCluster | Stop an instance | Stop an OceanBase instance. |
| StartCluster | Start an instance | Start an OceanBase instance. |
Tenant management
| Open API | Title | Open API description |
|---|---|---|
| DescribeTenants | Query tenant list in a cluster | Query metrics of an OceanBase node. |
| DescribeTenant | Query information about a specified tenant in a cluster | Query information about a specified tenant in a specified cluster. |
| CreateTenants | Create a tenant | Create a tenant. |
| DeleteTenants | Delete a tenant | Delete one or more tenants in a specified OceanBase cluster. |
| ModifyTenantName | Modify tenant name | Modify the name of a tenant in a specified OceanBase cluster. |
| ModifyTenant | Modify tenant information | Modify information about a tenant in a specified OceanBase cluster. |
| GetTenantCreateConstraints | Query constraints on creating tenants | Query the constraints on creating tenants in a specified OceanBase cluster. |
| GetTenantCreateCpuConstraints | Query CPU constraints on creating tenants | Query the CPU constraints on creating tenants in a specified OceanBase cluster. |
| GetTenantCreateMemConstraints | Query memory constraints on creating tenants | Query the memory constraints on creating tenants in a specified OceanBase cluster. |
| GetTenantModifyCpuConstraints | Query CPU constraints on modifying tenants | Query the CPU constraints on modifying tenants in a specified OceanBase cluster. |
| GetTenantModifyMemConstraints | Query memory constraints on modifying tenants | Query the memory constraints on modifying tenants in a specified OceanBase cluster. |
| CreateTenantSecurityIpGroup | Create a tenant security allowlist | Create a tenant security allowlist. |
| DescribeTenantSecurityIpGroups | Query tenant allowlist groups | Query the list of tenant allowlist groups. |
| ModifyTenantSecurityIpGroup | Modify tenant allowlist group information | Modify tenant allowlist group information. |
| DeleteTenantSecurityIpGroup | Delete a tenant allowlist group | Delete a tenant allowlist group. |
| DescribeTenantPrivateLink | Query tenant connection information | Query the connection information of a tenant. |
| DeletePrivatelinkConnection | Delete a tenant connection endpoint | Delete a tenant connection endpoint. |
| CreatePrivatelinkService | Enable tenant connection | Enable PrivateLink connection for a tenant. |
| ConnectPrivatelinkService | Connect to a database through a PrivateLink endpoint | Connect to a database through a PrivateLink endpoint. |
| AddPrivatelinkServiceUser | Add a user allowlist | Add a user allowlist. |
Tenant account management
| Open API | Title | Open API description |
|---|---|---|
| CreateTenantUser | Create a tenant user | Create a tenant account that can access a database in a specified tenant. |
| DescribeTenantUsers | List tenant users | List all database access accounts in a specified tenant. |
| DeleteTenantUsers | Delete a tenant user | Delete one or more database accounts. |
| ModifyTenantUserPassword | Change the password of a tenant user | Change the login password of a specified database account in the tenant. |
| ModifyTenantUserRoles | Change the role of a tenant user | Change the role of a database account under the specified tenant. |
Database management
| Open API | Title | Open API description |
|---|---|---|
| CreateDatabase | Create a database | Create a new database in a specified tenant. |
| DescribeDatabases | List databases | List all databases. |
| DeleteDatabases | Delete databases | Delete one or more databases. |
Database Proxy Management
| Open API | Title | Open API description |
|---|---|---|
| CreateTenantAddress | Create a tenant address | Create a tenant address. |
| CreateTenantSingleTunnelSLBAddres | Create a singleTunnelSLB address for a tenant | Create a singleTunnelSLB address for a tenant. |
| DeleteTenantAddress | Delete a tenant address | Delete a tenant address. |
| DescribeTenantAddress | Query a tenant address | Query a tenant address. |
| ModifyOdpClusterSpec | Modify the database proxy cluster specification | Modify the database proxy cluster specification. |
| ModifyTenantAddressPort | Modify the tenant address port | Modify the tenant address port. |
| ModifyTenantAddressDomainPrefix | Modify the tenant address domain prefix | Modify the tenant address domain prefix. |
| ConfirmPrivatelinkConnection | Confirm the completion of Private Link connection | Confirm the completion of Private Link connection. |
Monitoring management
| Open API | Title | Open API description |
|---|---|---|
| DescribeTenantMetrics | Query tenant metrics | Query the metrics of a specified OceanBase tenant. |
| DescribeMetricsData | Query monitoring metrics | Query one-dimensional or multi-dimensional monitoring metrics of an OceanBase cluster. |
Diagnostic management
| Open API | Title | Open API description |
|---|---|---|
| DescribeOasTopSQLList | Query TopSQL list | Queries the SQL execution performance data collected by the diagnostic system. |
| DescribeOasAnomalySQLList | Query suspicious SQL list | Queries the SQL statements identified by the diagnostic system as potentially having performance issues. |
| DescribeOasSlowSQLList | Query SlowSQL list | Queries the slow SQL statements. |
| DescribeOasSQLText | Query SQL text | Queries an OceanBase SQL text. |
Historical event management
| Open API | Title | Open API description |
|---|---|---|
| DescribeOperationEvents | Query historical events | Queries the information on historical events. |