API overview
API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (dms-dg/2023-09-14) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
API list
|
API |
Title |
Description |
| CreateGateway | Create Gateway | Invoke this API to create a new Database Gateway. |
| AddDatabase | Connect to a database through DG | You can invoke this API to connect databases from other clouds or on-premises environments to Alibaba Cloud. |
| AddDatabaseList | Batch connect databases through DG | You can invoke this API to batch add databases to a gateway. |
| CheckDGEnabled | Check whether the current user has activated the Database Gateway product | You can invoke this API to check whether the current user has activated the Database Gateway product. |
| ConnectDatabase | Database Connectivity Testing | Invoke this API to test database connectivity. |
| CreateGatewayVerifyCode | Generate a verification code required for offline gateway installation | You can invoke this API to generate a verification code required for offline gateway installation. This verification code corresponds to the gateway created in the cloud. |
| DeleteDatabase | Delete Database | You can invoke this API to delete a database added in Database Gateway. |
| DeleteGateway | Delete Gateway | You can invoke this API to delete a specified gateway. |
| DeleteGatewayInstance | Delete Gateway Edge Zone | You can invoke this API to delete a specified Database Gateway edge zone. |
| DescribeRegions | Obtain the regions supported by Database Gateway | You can invoke this API to obtain the list of regions that support Database Gateway creation. |
| DownloadGatewayProgram | Obtain the download URL of the gateway program | You can invoke this API to obtain the download URL of the gateway program. All Alibaba Cloud users can download it without authentication. |
| FindUserGatewayById | Obtain the details of a gateway. | You can invoke this API to obtain detailed information about a gateway, such as the gateway's creator and the number of running edge zones. |
| GetUserDatabases | Obtain the database list in the gateway | You can invoke this API to view the list of databases added to a specified gateway. |
| GetUserGatewayInstances | Obtain detailed information about gateway edge zones | You can invoke this API to obtain detailed information about gateway edge zones. |
| GetUserGateways | Retrieve gateway list | You can invoke this API to obtain the list of DG gateways created by the user. |
| ListDatabaseAccessPoint | Obtain the database endpoint list | You can invoke this API to obtain the database endpoint list. |
| ModifyDatabase | Modify Database Information | You can invoke this API to modify information such as the database description. |
| ModifyGateway | Modify the basic information of a gateway | You can invoke this API to modify the basic information of a gateway, including the gateway name and gateway description. |
| RetryDatabase | Reconnect Database | You can invoke this API to reconnect the Database Gateway to the database. |
| StopGateway | Stop Gateway Service | You can invoke this API to stop the gateway service. |