调用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
}

错误码

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