PolarDB-X exposes a Query API that accepts HTTP GET requests with URL-encoded parameters. This reference covers the regional endpoints, supported protocols, request URL format, parameter types, and encoding requirements.
Endpoints
Send API requests to the endpoint for the region where your PolarDB-X instance is deployed.
| Region | Endpoint |
|---|---|
| China (Hangzhou) | polardbx.cn-hangzhou.aliyuncs.com |
| China (Beijing) | polardbx.cn-beijing.aliyuncs.com |
Protocols
PolarDB-X supports both HTTP and HTTPS. Use HTTPS to keep data secure in transit.
Request syntax
All PolarDB-X API calls use HTTP GET. Construct the request URL as follows:
http://{Endpoint}/?Action={OperationName}&Version=2020-02-02&{Parameters}| Component | Description | Example |
|---|---|---|
{Endpoint} | The regional endpoint for the PolarDB-X API | polardbx.cn-hangzhou.aliyuncs.com |
Action | The name of the API operation to call | DescribeTables |
Version | The API version. Always set to 2020-02-02 | 2020-02-02 |
{Parameters} | Operation-specific parameters, separated by & | Param1=Value1&Param2=Value2 |
A complete request URL looks like this:
http://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeTables&Version=2020-02-02&Param1=Value1Request parameters
Each request includes two categories of parameters:
Common parameters — required for every API call, including
Action,Version, and authentication credentials. See Common parameters.Operation-specific parameters — additional parameters required by the specific operation you are calling.
Set Action to the name of the operation you want to call. For example, set Action=CreateDatabase to create a database.
Character encoding
Encode all requests and responses in UTF-8.