检查数据库连通性
更新时间：2023-10-12
接口说明
检查数据库入口连通性
请求结构
POST /v{version}/task/check_conn
Host: dts.baidubce.com
Authorization: authorization string
{
"connection" : {
"dbPass" : "dbPass",
"dbPort" : 3306,
"instanceId" : "",
"instanceType" : "",
"dbUser" : "_dts_trans_",
"dbType" : "mysql",
"dbHost" : "192.168.1.1",
"region" : "bj"
}
}请求体参数
请求体字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| version | String | 是 | API版本号 | "1" | URL参数 |
| connection | Connection | 是 | 连通参数 | connection | Request Body 参数 |
Connection字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceType | String | 是 | 实例类型 | bcerds |
| region | String | 是 | 地域 | bj |
| dbType | String | 是 | 数据库类型 | mysql |
| dbUser | String | 是 | 数据库访问账号 | dts_trans |
| dbPass | String | 是 | 数据库访问密码 | dbPass |
| dbPort | Integer | 是 | 数据库访问端口 | 3306 |
| dbHost | String | 是 | 数据库ip或主机名 | 192.168.1.1 |
| instanceId | String | 是 | 实例ID | rdsmfgdti3d53f5 |
| instanceId | String | 是 | 实例ID | rdsmfgdti3d53f5 |
| vpcId | String | 否 | 接入类型为bcegateway时，需要指定VPC ID | vpcId |
| subnetId | String | 否 | 接入类型为bcegateway时，需要指定子网ID | subnetId |
| sid | String | 否 | oracle实例的SID或Service Name，dbType为oracle时为必选 | sid |
| pdbName | String | 否 | oracle实例的PDB名称，dbType为oracle时为可选 | pdbName |
响应头参数
除公共头域，无其它特殊头域。
响应体参数
响应体字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| success | boolean | 是 | 是否成功 | true |
| result | Object | 是 | 返回结果 | result |
请求示例
POST /v1/task/check_conn
Host: dts.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
{
"connection" : {
"dbPass" : "dbPass",
"dbPort" : 3306,
"instanceId" : "",
"instanceType" : "",
"dbUser" : "_dts_trans_",
"dbType" : "mysql",
"dbHost" : "192.168.1.1",
"region" : "bj"
}
}响应示例
HTTP/1.1 200 OK
{
"dtsId" : "dtsxxxyyyzzz"
}