ConnectDatabase - 数据库连通性测试

更新时间: 2024-07-12 15:30:07

调用此API对数据库连通性进行测试。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
GatewayIdstring

网关 ID。

dg-58c36y906675****
Hoststring

通过网关所在宿主机去访问数据库的地址。

127.0.XX.XX
Portinteger

通过网关所在宿主机去访问数据库的端口。

3306
DbTypestring

数据库类型。

MYSQL
DbUserNamestring

访问数据库所用的用户名。

test_usr
DbPasswordstring

访问数据库所用的密码。

1234!2#%A****
DbNamestring

数据库名称。

test

返回参数

名称类型描述示例值
object
Codestring

响应码。

200
Datastring

返回结果。

OK
ErrorMsgstring

报错信息。

Gateway exception, please launch local dg first
RequestIdstring

请求 ID,用于定位日志,排查问题。

F4EFCDC5-E69C-5A6F-B170-C5379D9D6811
Successboolean

请求是否成功,返回值如下:

  • true:请求成功。
  • false:请求失败。
true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Data": "OK",
  "ErrorMsg": "Gateway exception, please launch local dg first",
  "RequestId": "F4EFCDC5-E69C-5A6F-B170-C5379D9D6811",
  "Success": true
}

错误码

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

上一篇: CheckDGEnabled - 检查当前用户是否开通数据库网关产品 下一篇: CreateGatewayVerifyCode - 生成线下安装网关时需要的验证码
阿里云首页 数据管理 相关技术圈