OceanBase Cloud Platform (OCP) provides HTTP APIs that conform to the REST specification to facilitate you in managing your OceanBase resources and developing your own applications. This topic describes APIs of OCP, including their syntax and examples. The document is intended for developers. Before you call an API operation, make sure that you fully understand the related concepts.
List of API operations
| Module | Operation | Description |
|---|---|---|
| Cluster information | Query clusters | Queries the information about the clusters managed by OCP. |
| Cluster information | Query servers | Queries the information about all servers in a cluster. |
| Cluster information | Query servers in a zone | Queries servers in a specified zone of a cluster. |
| Tenant information | Query tenants of a cluster | Queries tenants of a cluster. |
| Tenant information | Query all tenants | Queries the information of all tenants in a cluster managed by OCP. |
| Monitoring | Query the metadata of a monitoring metric | Queries the metadata information of a monitoring metric in OCP. You can query the monitoring data of a specified metric based on the metadata. |
| Monitoring | Query monitoring data | Queries the monitoring data of a specified metric. The time range must be specified. |
| Monitoring | Query monitoring data and attach a tag to the data | Queries the monitoring data of a specified metric. The time range must be specified. The returned results contain values of group tags. |
| Alerts | Query the alert event list | Queries the alert event list. |
| Alerts | Query alert events | Queries the information about a single alert event. |
| Alerts | Query alert notifications | Queries alert notifications based on conditions, recipient, and sending time. |
| Performance | Query performance indicators of an SQL statement | Queries SQL performance indicators of a tenant, and specifies an interval to collect SQL performance of the period. Performance data includes the cluster, tenant, server, database, user, and SQL _ID data. |
| Performance | Query the performance indicator trend of an SQL statement | Queries the performance trend of an SQL statement within a specified time range. |
| Performance | Query SQL text | Queries the full text of an SQL statement with the specified ID. |
| Performance | Query performance indicators of an execution plan | Queries the performance of an execution plan associated with the specified SQL statement. |
| Performance | Query the performance indicator trend of an execution plan | Queries the performance trend of an execution plan associated with the specified SQL statement. |
| Performance | Query the operator structure of an execution plan | Queries the operator structure of an execution plan. |
| Others | Query the basic information of an OCP application | Queries the basic information about an OCP application, such as the version number, build date, and Java version. |
| Others | Query the OCP server time | Queries the OCP server time to check the synchronization between the local time and the server time. |
| Others | Query OCP application status | Queries the status of the OCP application. It checks the status of each module of the OCP application and returns the health status of all modules. |
