接口功能介绍
一键检测实例连接状态。
接口约束
请先订购实例。
URI
POST /v2/instance/check
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | 产品实例id | cb236d462b924ef7bfba5ecf1d61de2b |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success | |
result | 否 | Object | 返回对象,若无该字段或该字段为null,都代表返回对象为空。 | result |
表result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
cost | 是 | Integer | 检测耗时(毫秒) | 100 | |
result | 是 | String | 检测结果 | success | |
index | 是 | Integer | 检测顺序 | 0 | |
failCount | 是 | Integer | 失败数量 | 0 | |
resultMsg | 否 | String | 结果描述 | ||
detectResults | 否 | Array of Objects | 节点检测结果列表 | detectResult |
表detectResult
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
cost | 是 | Integer | 检测耗时(毫秒) | 100 | |
result | 是 | String | 检测结果 | success | |
index | 是 | Integer | 检测顺序 | 0 | |
failCount | 是 | Integer | 失败数量 | 0 | |
resultMsg | 否 | String | 结果描述 | ||
connectionInfo | 否 | Array of Objects | 连接信息 | connectionInfo |
表connectionInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | 分组id | ||
ip | 是 | String | 节点ip | 172.16.0.3 | |
shownIp | 否 | String | 节点展示ip | 172.16.0.3 | |
memo | 是 | String | 节点名称 | n1 | |
port | 是 | Integer | 连接端口 | 18100 | |
checkCreateUserPrivilege | 是 | Boolean | 是否检测用户权限 | true |
请求示例
请求头header
无
请求体body
无
响应示例
{
"code": 0,
"message": "success",
"result": {
"index": 0,
"failCount": 0,
"cost": 95,
"result": "success",
"detectResults": [
{
"index": 0,
"failCount": 0,
"cost": 93,
"connectionInfo": {
"ip": "172.16.0.3",
"shownIp": "172.16.0.3",
"port": 18100,
"memo": "n1",
"id": "/dbproxy_cluster/dbproxy_cluster_0000000121/nodes/node_0000000206",
"checkCreateUserPrivilege": true
},
"result": "success",
"resultMsg": "n1连接成功"
},
{
"index": 1,
"failCount": 0,
"cost": 79,
"connectionInfo": {
"ip": "172.16.0.4",
"shownIp": "172.16.0.4",
"port": 18100,
"memo": "n2",
"id": "/dbproxy_cluster/dbproxy_cluster_0000000121/nodes/node_0000000208",
"checkCreateUserPrivilege": true
},
"result": "success",
"resultMsg": "n2连接成功"
}
]
}
}
状态码
请参考 状态码说明。