跳转到主要内容
API Explorer|API Explorer
基础设施相关接口/安装器
POSTInstaller起始版本 1.0同步需要认证

探测TCP连通性探测TCP

连通性指定主机端口安装器节点。

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • hostString必填

    主机地址。

    示例： 192.168.1.10

  • portInteger必填

    端口号。

    示例： 5432

  • timeoutMsInteger必填

    连接超时时间毫秒默认5000最大30000。

    示例： 5000

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • reachableBoolean

    是否可达。

    示例： true

  • errorString

    错误码。操作成功时为 null，失败时返回具体错误信息。

    示例： connection refused

请求地址

POST/api/v1/installer/probe/tcp

/api/v1/installer/probe/tcp

操作 ID

ProbeTCP

永久链接

请求示例

curl -X POST '{host}/api/v1/installer/probe/tcp' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"host":"192.168.1.10","port":5432,"timeoutMs":5000}'

响应示例

200
{
  "reachable": true,
  "error": "connection refused"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史