This topic describes the basic concepts of PolarDB-X 1.0 OpenAPI, including its supported scenarios, basic principles, features, and limitations.
Users and scenarios
OpenAPI is a tool provided by PolarDB-X 1.0 that you can use to manage PolarDB-X 1.0 resources. You can use it to perform various resource management and operations and maintenance (O&M) tasks. Key features include managing the lifecycle of PolarDB-X 1.0 instances, maintaining database and table information, and managing permissions.
The main users of OpenAPI include the following:
Users who have activated the PolarDB-X 1.0 service and want to perform management tasks similar to those in the console, or who require custom management features.
Users who are familiar with the main features of the PolarDB-X 1.0 console and need to integrate PolarDB-X 1.0 management capabilities into their own platforms.
Scenarios and limitations
OpenAPI currently supports only public cloud and Finance Cloud regions. It does not support private clouds. For more information about region availability, see the official documentation.
OpenAPI is in public preview. Its stability and reliability are still being optimized. If you encounter any issues, contact PolarDB-X 1.0 technical support.
Because of its underlying architecture, the client that calls OpenAPI must have public network access. Otherwise, the call fails.
OpenAPI is built on the HTTP protocol, which can result in lower performance and efficiency. Therefore, it is suitable only for management scenarios. Do not use it for production scenarios that involve large batches or high concurrency.
Basic principles of OpenAPI
OpenAPI provides services through underlying HTTP interfaces. When you call the OpenAPI software development kit (SDK), an HTTP request is sent to the Alibaba Cloud application gateway. The gateway then forwards the request to the PolarDB-X 1.0 console for processing.
The call chain is shown in the following figure:
