本文主要介绍PolarDB-X支持的API请求结构,包括服务地址、请求协议和请求方法等。

服务地址

PolarDB-X支持的API服务接入地址请参见下表。

地域(部署位置) 接入地址(Endpoint)
华东1(杭州) polardbx.cn-hangzhou.aliyuncs.com
华北2(北京) polardbx.cn-beijing.aliyuncs.com

通信协议

支持通过HTTP或HTTPS通道进行请求通信。为了获得更高的安全性,推荐您使用HTTPS通道发送请求。

请求方法

支持HTTP GET方法发送请求,这种方式下请求参数需要包含在如下的请求URL中。

http://Endpoint/?Action=xx&Parameters
说明
  • Endpoint:分布式关系型数据库API的服务接入地址,详情请参见服务地址
  • Action:要执行的操作,如调用DescribeTables查询已创建的分布式关系型数据库的数据表。
  • Version:要使用的API版本,当前的API版本是2020-02-02
  • Parameters:请求参数,每个参数之间用英文and符号(&)分隔。

    请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息,详情请参见公共参数

请求参数

每个请求都需要指定要执行的操作,即Action参数(例如CreateDatabase),以及每个操作都需要包含的公共请求参数和指定操作所特有的请求参数。

字符编码

请求及返回结果都使用UTF-8字符集进行编码。