調用此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"
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。