调用此API可以修改数据库描述等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Host |
string |
是 |
通过网关所在宿主机去访问数据库的地址。 |
127.0.XX.XX |
| Port |
integer |
是 |
通过网关所在宿主机去访问数据库的端口。 |
3306 |
| DbType |
string |
否 |
数据库类型。 |
MYSQL |
| DbUserName |
string |
否 |
访问数据库所用的用户名。 |
test |
| DbPassword |
string |
否 |
访问数据库所用的密码。 |
817130**** |
| DbDescription |
string |
否 |
数据库描述。 |
测试库 |
| InstanceId |
string |
是 |
数据库实例 ID。 |
dg-db-n2a285spnpy3**** |
| DbName |
string |
否 |
数据库名称。 |
test |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
响应码。 |
200 |
| Data |
string |
返回结果。 |
SUCCESS |
| ErrorMsg |
string |
报错信息。 |
Gateway exception, please launch local dg first |
| RequestId |
string |
请求 ID，用于定位日志，排查问题。 |
8F29E3E9-2847-53BF-ADF0-130E3CEA5C63 |
| Success |
boolean |
请求是否成功，返回值如下：
|
true |
示例
正常返回示例
JSON格式
{
"Code": "200",
"Data": "SUCCESS",
"ErrorMsg": "Gateway exception, please launch local dg first",
"RequestId": "8F29E3E9-2847-53BF-ADF0-130E3CEA5C63",
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。