调用此API对数据库连通性进行测试。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| GatewayId |
string |
是 |
网关 ID。 |
dg-58c36y906675**** |
| Host |
string |
是 |
通过网关所在宿主机去访问数据库的地址。 |
127.0.XX.XX |
| Port |
integer |
是 |
通过网关所在宿主机去访问数据库的端口。 |
3306 |
| DbType |
string |
否 |
数据库类型。 |
MYSQL |
| DbUserName |
string |
否 |
访问数据库所用的用户名。 |
test_usr |
| DbPassword |
string |
否 |
访问数据库所用的密码。 |
1234!2#%A**** |
| DbName |
string |
否 |
数据库名称。 |
test |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
响应码。 |
200 |
| Data |
string |
返回结果。 |
OK |
| ErrorMsg |
string |
报错信息。 |
Gateway exception, please launch local dg first |
| RequestId |
string |
请求 ID，用于定位日志，排查问题。 |
F4EFCDC5-E69C-5A6F-B170-C5379D9D6811 |
| Success |
boolean |
请求是否成功，返回值如下：
|
true |
| AccessDeniedDetail |
object |
请求失败详情。 |
|
| AuthAction |
string |
接口名。 |
dms-dg:ConnectDatabase |
| AuthPrincipalDisplayName |
string |
请求中用于鉴权的身份标识。 |
23894333884425**** |
| AuthPrincipalOwnerId |
string |
授权主体所有者 ID。 |
1218522260143*** |
| AuthPrincipalType |
string |
授权主体类型。 |
SubUser |
| EncodedDiagnosticMessage |
string |
加密后的完整诊断信息。 |
AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ== |
| NoPermissionType |
string |
导致鉴权失败的原因。 |
ExplicitDeny |
| PolicyType |
string |
导致鉴权失败的策略类型。 |
COST_OPTIMIZED |
示例
正常返回示例
JSON格式
{
"Code": "200",
"Data": "OK",
"ErrorMsg": "Gateway exception, please launch local dg first",
"RequestId": "F4EFCDC5-E69C-5A6F-B170-C5379D9D6811",
"Success": true,
"AccessDeniedDetail": {
"AuthAction": "dms-dg:ConnectDatabase",
"AuthPrincipalDisplayName": "23894333884425****",
"AuthPrincipalOwnerId": "1218522260143***",
"AuthPrincipalType": "SubUser",
"EncodedDiagnosticMessage": "AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==",
"NoPermissionType": "ExplicitDeny",
"PolicyType": "COST_OPTIMIZED"
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。