文档

OpenAPI 简介

更新时间:

本文介绍PolarDB-X 1.0 OpenAPI的基本概念,包括适用场景、基本原理、功能以及局限性。

面向用户和场景

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

OpenAPI的主要用户包括:

  • 已经开通PolarDB-X 1.0服务,需要实现类似控制台的管控,有定制自定义管控功能等需求;

  • 已经熟悉PolarDB-X 1.0控制台的主要功能,有需要对接用户方管控平台的需求。

适用场景和局限性

  • OpenAPI目前仅支持公共云和金融云区域,对于私有云暂不支持,同时云上各个Region的开通情况请以实际公开的Region信息为准。

  • OpenAPI目前属于公测阶段,稳定性和可靠性还在逐步优化,使用过程中遇到问题请联系PolarDB-X 1.0技术人员提供支持。

  • OpenAPI由于其实现原理,调用端必须具备公网访问能力,否则无法调通。

  • OpenAPI底层基于HTTP协议实现,性能和效率不高,仅适用于管控场景,请勿用于大批量高并发的生产场景。

OpenAPI 基本原理

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

调用链路如下图所示:

open_api
  • 本页导读 (0)
文档反馈