This topic describes the request structure that is supported by PolarDB-X. A request includes the endpoints of the PolarDB-X API, and the syntax and protocols that can be used to send API requests.
Endpoints
The following table lists the endpoints of the PolarDB-X API.
| Region | Endpoint |
|---|---|
| China (Hangzhou) | polardbx.cn-hangzhou.aliyuncs.com |
| China (Beijing) | polardbx.cn-beijing.aliyuncs.com |
Protocols
You can send requests over HTTP or HTTPS. To ensure that your data is secure, we recommend that you send requests over HTTPS.
Request syntax
You can call PolarDB-X API operations by sending HTTP GET requests. To send an HTTP GET request, include request parameters in the following request URL:
http://Endpoint/?Action=xx&Parameters- Endpoint: the endpoint of the PolarDB-X API. For more information, see Endpoints.
- Action: the name of the operation that you want to call. For example, if you want to query tables that are created in your PolarDB-X database, you must set the Action parameter to DescribeTables.
- Version: the version of the PolarDB-X API. Set the value to 2020-02-02.
- Parameters: the request parameters for the operation. Separate multiple parameters by using
ampersands (&).
Request parameters include both common parameters and operation-specific parameters. Common parameters include the API version and the authentication information. For more information, see Common parameters.
Request parameters
You must configure the Action parameter based on the API operation that you want to call. For example, set Action to CreateDatabase. You must also configure other common request parameters and operation-specific request parameters that are required to call the operation.
Character encoding
Requests and responses are encoded in UTF-8.