调用此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 |
返回参数
示例
正常返回示例
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"
}
}错误码
访问错误中心查看更多错误码。