本产品(
数据管理 - 数据库网关/2023-09-14
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
API目录
API | 标题 | API概述 |
---|---|---|
CreateGateway | 创建网关 | 调用此API创建一个全新的数据库网关。 |
AddDatabase | 通过DG接入数据库 | 调用此API可以将他云或本地的数据库接入至阿里云。 |
AddDatabaseList | 通过DG批量接入数据库 | 调用此API可以在网关中批量添加数据库。 |
CheckDGEnabled | 检查当前用户是否开通数据库网关产品 | 调用此API可以检查当前用户是否开通数据库网关产品。 |
ConnectDatabase | 数据库连通性测试 | 调用此API对数据库连通性进行测试。 |
CreateGatewayVerifyCode | 生成线下安装网关时需要的验证码 | 调用此API可以生成线下安装网关时需要的验证码。该验证码将与云上创建的网关相对应。 |
DeleteDatabase | 删除数据库 | 调用此API可删除数据库网关中添加的数据库。 |
DeleteGateway | 删除网关 | 调用此API可以删除指定网关。 |
DeleteGatewayInstance | 删除网关节点 | 调用此API可以删除指定的数据库网关节点。 |
DescribeRegions | 获取数据库网关支持的地域 | 调用此API可以获取支持创建数据库网关的地域。 |
DownloadGatewayProgram | 获取网关程序的下载地址 | 调用此API可以获取网关程序的下载地址。阿里云用户均可下载,无需权限认证。 |
FindUserGatewayById | 获取网关的详细信息 | 调用此API可以获取网关的详细信息,包括网关的创建人、运行中的网关节点数量等信息。 |
GetUserDatabases | 获取网关中的数据库列表 | 调用此API可以查看指定网关中已添加的数据库列表信息。 |
GetUserGatewayInstances | 获取网关节点详细信息 | 调用此API可以获取网关节点的详细信息。 |
GetUserGateways | 获取网关列表 | 调用此API可以获取用户创建的DG网关列表。 |
ListDatabaseAccessPoint | 获取数据库访问点列表 | 调用此API可以获取数据库访问点列表。 |
ModifyDatabase | 修改数据库信息 | 调用此API可以修改数据库描述等信息。 |
ModifyGateway | 修改网关的基本信息 | 调用该API可以修改网关的基本信息,包含网关名称和网关描述。 |
RetryDatabase | 重新连接数据库 | 调用此API可以使数据库网关重新连接数据库。 |
StopGateway | 停止网关服务 | 调用此API可以停止网关服务。 |