调用AddDatabase API通过DG接入他云或本地数据库-数据管理 DMS-阿里云

调用此API可以将他云或本地的数据库接入至阿里云。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	是	网关 ID。	dg-8d9bqu1030m****
Host	string	是	通过网关所在宿主机去访问数据库的地址。	127.0.XX.XX
Port	integer	是	通过网关所在宿主机去访问数据库的端口。	3306
DbType	string	否	数据库类型。	MYSQL
DbUserName	string	否	访问数据库所用的用户名。	test_usr
DbPassword	string	否	访问数据库所用的密码。说明仅用于验证数据库是否可以连接成功，不做任何其他工作。	1234!2#%A***
DbDescription	string	否	数据库的描述。	测试
RegionId	string	是	数据库所在地域。	cn-hangzhou
DbName	string	否	数据库名称。	test
ClientToken	string	否	该参数值由客户端生成，用于确保请求的幂等性。该参数值在不同请求间是唯一的，并且区分大小写，长度不超过 64 个 ASCII 字符。	ETnLKlblzczshOTUbOCzxxxx

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	200
ErrorMsg	string	报错信息。	SYSTEM_ERR
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	A8B2EED2-70EF-51F1-8820-914F9AC9BAD2
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
DbInstance	object	数据库连接实例列表。
Port	integer	通过网关所在宿主机去访问数据库的端口。	3306
Host	string	通过网关所在宿主机去访问数据库的地址。	127.0.0.1
GatewayId	string	网关 ID。	dg-8d9bqu1030mhk0ix
DbType	string	数据库类型。	MYSQL
RegionId	string	地域 ID。	cn-hangzhou
ConnectHost	string	数据库连接在 DG 服务侧的映射地址。	10.0.0.1
ConnectPort	integer	数据库连接在 DG 服务侧的映射端口。	32875
ServiceType	string	DG 服务器类型。	ECS
NetworkType	string	DG 服务器网络类型。	VPC
NodeId	string	DG 服务器节点 ID。	dg-node-r0SR-E90lsIRNgj6B_9m
InstanceStatus	string	当前 DG 网关实例的状态。	SUCCESS
DbDescription	string	备注信息	test
InstanceId	string	数据库连接实例 ID。	dg-db-rgfg9p4586o7y79b
GatewayName	string	网关名称。	测试
UserId	string	用户 ID。	167xxxxxxxxxx
ParentId	string	归属主账号 ID。	167xxxxxxxxxx
VpcId	string	DG 服务器所在 VPC 的 ID。	vpc-xxxxx
VpcInstanceId	string	VPC 实例 ID。	i-xxxxxxx
AccessDeniedDetail	object
AuthAction	string
AuthPrincipalDisplayName	string
AuthPrincipalOwnerId	string
AuthPrincipalType	string
EncodedDiagnosticMessage	string
NoPermissionType	string
PolicyType	string

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "ErrorMsg": "SYSTEM_ERR",
  "RequestId": "A8B2EED2-70EF-51F1-8820-914F9AC9BAD2",
  "Success": true,
  "DbInstance": {
    "Port": 3306,
    "Host": "127.0.0.1",
    "GatewayId": "dg-8d9bqu1030mhk0ix",
    "DbType": "MYSQL",
    "RegionId": "cn-hangzhou",
    "ConnectHost": "10.0.0.1",
    "ConnectPort": 32875,
    "ServiceType": "ECS",
    "NetworkType": "VPC",
    "NodeId": "dg-node-r0SR-E90lsIRNgj6B_9m",
    "InstanceStatus": "SUCCESS",
    "DbDescription": "test",
    "InstanceId": "dg-db-rgfg9p4586o7y79b",
    "GatewayName": "测试",
    "UserId": "167xxxxxxxxxx",
    "ParentId": "167xxxxxxxxxx",
    "VpcId": "vpc-xxxxx",
    "VpcInstanceId": "i-xxxxxxx"
  },
  "AccessDeniedDetail": {
    "AuthAction": "",
    "AuthPrincipalDisplayName": "",
    "AuthPrincipalOwnerId": "",
    "AuthPrincipalType": "",
    "EncodedDiagnosticMessage": "",
    "NoPermissionType": "",
    "PolicyType": ""
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。