PolarDB-X 1.0-API参考-1.0（2017版本）-OpenAPI简介

面向用户和场景

OpenAPI 是 PolarDB-X 提供的管理 PolarDB-X 资源的手段，用于实现一系列资源管理和运维功能。主要功能包括有管理 PolarDB-X 实例的生命周期、运维 PolarDB-X 库表信息及权限管理等。

OpenAPI 的主要用户包括：

• 已经开通 PolarDB-X 服务，需要实现类似控制台的管控，有定制自定义管控功能等需求；
• 已经熟悉 PolarDB-X 控制台的主要功能，有需要对接用户方管控平台的需求。

适用场景和局限性

• OpenAPI 目前仅支持公共云和金融云区域，对于私有云暂不支持，同时云上各个 Region 的开通情况请以实际公开的 Region 信息为准。
• OpenAPI 目前属于公测阶段，稳定性和可靠性还在逐步优化，使用过程中遇到问题请联系 PolarDB-X 技术人员提供支持。
• OpenAPI 由于其实现原理，调用端必须具备公网访问能力，否则无法调通。
• OpenAPI 底层基于 HTTP 协议实现，性能和效率不高，仅适用于管控场景，请勿用于大批量高并发的生产场景。

OpenAPI 基本原理

OpenAPI 底层通过 HTTP 接口提供服务，用户调用 OpenAPI 的 SDK，发出 HTTP 请求到阿里云应用网关，再由阿里云应用网关将请求转发给 PolarDB-X 的控制台去执行。

调用链路如下图所示：