调用此API可以使数据库网关重新连接数据库。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
GatewayId | string | 是 | 网关 ID。 | dg-nmz841r7b681**** |
Host | string | 是 | 通过网关所在宿主机去访问数据库的地址。 | 127.0.XX.XX |
Port | integer | 是 | 通过网关所在宿主机去访问数据库的端口。 | 3306 |
DbType | string | 是 | 数据库类型。 | MYSQL |
DbUserName | string | 是 | 访问数据库所用的用户名。 | test |
DbPassword | string | 是 | 访问数据库所用的密码。 | HongRui**** |
DbDescription | string | 否 | 数据库描述。 | 测试库 |
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
DbName | string | 否 | 数据库名称。 | test |
ClientToken | string | 否 | 该参数值由客户端生成,用于确保请求的幂等性。该参数值在不同请求间是唯一的,并且区分大小写,长度不超过 64 个 ASCII 字符。 | XXXXX |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Data": "SUCCESS",
"ErrorMsg": "Gateway exception, please launch local dg first",
"RequestId": "19EDB8E2-FCE6-5797-91F4-80F832C90371",
"Success": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | Error | The requested service is unavailable. Please try again later. | 服务异常,请重试 |
访问错误中心查看更多错误码。