跳到主要内容

测试数据库可用性

该接口旨在测试数据库可用性，请求成功会返回对应节点的数据库可用性信息。

请求 URI​

POST /test-db-validity

参数说明​

{
  "agentType": 0,
  "databaseConfig": [
    {
      "host": "string",
      "userName": "string",
      "passWord": "string",
      "dbType": "string"
    }
  ]
}

参数说明如下：

参数名说明
agentTypeNUMBER 类型，软件包的类型：0 为源端，1 为备端。
databaseConfig数据库连接参数。

databaseConfig 参数说明如下：

参数名说明
hostSTRING 类型，格式：IP/端口。
userNameSTRING 类型，数据库用户名。
passWordSTRING 类型，数据库登录密码。
dbTypeSTRING 类型，数据库类型。

使用样例​

以下请求会测试一个 oracle 数据库的源端可用性。

curl -i -X POST \
   -H "Content-Type:application/json" \
   -d \
'{
  "agentType": 0,
  "databaseConfig": [
    {
      "host": "172.21.16.4:1621/lhr11g",
      "userName": "***",
      "passWord": "***",
      "dbType": "oracle"
    }
  ]
}' \
 'http://172.21.16.3:8089/test-db-validity'

响应体格式​

{ "stateCode": 0, "stateMsg": "" }

参数说明如下：

参数名说明
stateCodeNUMBER 类型，错误码。0 表示成功
stateMsgSTRING 类型，错误消息