API overview

更新时间:
复制 MD 格式

Database Gateway exposes the following API operations.

Gateway management

APIDescription
CreateGatewayCall the CreateGateway operation to create a gateway.
ModifyGatewayModifies the basic information of a gateway.
DeleteGatewayDeletes a gateway.
StopGatewayYou can call the StopGateway operation to stop the gateway service.
CreateGatewayVerifyCodeGenerates a verification code required for installing a gateway on-premises.
DownloadGatewayProgramRetrieves the download URL of the gateway program.
ConnectDatabaseTests the connectivity to a database through a gateway.
GetUserDatabasesReturns a list of user databases.
AddDatabaseCall the AddDatabase operation to add a database.
ModifyDatabaseModifies database information.
DeleteDatabaseDeletes a database.

Other

APIDescription
AddDatabaseListAdds databases in a batch.
CreateDatabaseAccessPointThe CreateDatabaseAccessPoint operation creates a database endpoint.
DeleteDatabaseAccessPointDeletes a database access point.
DeleteGatewayInstanceDeletes a database gateway node.
DescribeRegionsRetrieves the supported regions.
FindUserGatewayByIdRetrieves the details of a gateway by its ID.
GetUserGatewayInstancesRetrieves the details of gateway nodes.
GetUserGatewaysRetrieves a list of gateways.
ListDatabaseAccessPointRetrieves a list of database endpoints.
RetryDatabaseCall the RetryDatabase API to retry the database operation.