The PolarDB-X 1.0 API uses HTTP GET over HTTPS. All requests share a common URL structure with a fixed set of required parameters.
Endpoints
Send requests to the endpoint for the region where your PolarDB-X 1.0 instance is located.
| Region | Endpoint |
|---|---|
| China (Hangzhou) | drds.cn-hangzhou.aliyuncs.com |
| China (Shanghai) | drds.cn-shanghai.aliyuncs.com |
| China (Qingdao) | drds.cn-qingdao.aliyuncs.com |
| China (Beijing) | drds.cn-beijing.aliyuncs.com |
| China (Hohhot) | drds.cn-huhehaote.aliyuncs.com |
| China (Shenzhen) | drds.cn-shenzhen.aliyuncs.com |
| China (Zhangjiakou-Beijing Winter Olympics) | drds.cn-zhangjiakou.aliyuncs.com |
| China (Hong Kong) | drds.cn-hongkong.aliyuncs.com |
| Singapore (Singapore) | drds.ap-southeast-1.aliyuncs.com |
| US (Virginia) | drds.us-east-1.aliyuncs.com |
Protocols
You can send requests over HTTP or HTTPS. We recommend that you use HTTPS for enhanced security.
Request method
All API operations use HTTP GET. Include all parameters in the URL query string.
http://Endpoint/?Action=<operation>&Version=2019-01-23&<parameters>Each request URL contains the following components:
| Component | Description | Example |
|---|---|---|
Endpoint |
Regional endpoint for the PolarDB-X 1.0 API | drds.cn-hangzhou.aliyuncs.com |
Action |
Name of the API operation | DescribeTables |
Version |
API version. Always set to 2019-01-23. |
2019-01-23 |
<parameters> |
Request parameters for the operation, separated by ampersands (&) |
DBInstanceId=drds-xxx |
Request parameters
Every request includes two types of parameters:
-
Common parameters — required for all API calls regardless of the operation. See Common parameters.
-
Operation-specific parameters — additional parameters defined for each individual operation.
Character encoding
All requests and responses use UTF-8 encoding.