全部產品
Search
文件中心

Database Gateway - Deprecated:ConnectDatabase

更新時間:Feb 28, 2025

調用ConnectDatabase通過網關進行資料庫連通性測試。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String ConnectDatabase

系統規定參數。取值:ConnectDatabase

GatewayId String dg-yhss6sdlaff****

網關ID。

Host String 11.163.23.109

通過網關所在宿主機去訪問資料庫的地址。

Port Integer 3440

通過網關所在宿主機去訪問資料庫的連接埠。

DbType String MySQL

資料庫類型。

說明 目前資料庫類型僅支援MySQL。
DbUserName String dg_test

訪問資料庫所用的使用者名稱。

DbPassword String password

訪問資料庫所用的密碼。

DbName String db_name

資料庫名稱。

返回資料

名稱 類型 樣本值 描述
Code String OK

響應碼。

Data String test_data

返回結果。

ErrorMsg String SYSTEM_ERR

異常資訊。

RequestId String EAF2AA07-860D-43DA-BEE8-1E43AAE024DG

請求ID。

Success Boolean true

請求是否成功,傳回值如下:

  • true:請求成功。
  • false:請求失敗。

樣本

請求樣本

http(s)://dg.cn-hangzhou.aliyuncs.com/?Action=ConnectDatabase
&GatewayId=dg-yhss6sdlaff****
&Host=11.163.23.109
&Port=3440
&DbType=MySQL
&DbUserName=dg_test
&DbPassword=password
&DbName=db_name
&公用請求參數

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ConnectDatabaseResponse>
    <Code>OK</Code>
    <Data>test_data</Data>
    <ErrorMsg>SYSTEM_ERR</ErrorMsg>
    <RequestId>EAF2AA07-860D-43DA-BEE8-1E43AAE024DG</RequestId>
    <Success>true</Success>
</ConnectDatabaseResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Code" : "OK",
  "Data" : "test_data",
  "ErrorMsg" : "SYSTEM_ERR",
  "RequestId" : "EAF2AA07-860D-43DA-BEE8-1E43AAE024DG",
  "Success" : true
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。