跳转到主要内容
ZStack
基础设施相关接口/安装器

探测TCP连通性探测TCP

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

POST/api/v1/installer/probe/tcp

操作 ID

ProbeTCP

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • host
    String必填

    主机地址。

    示例： 192.168.1.10

  • port
    Integer必填

    端口号。

    示例： 5432

  • timeoutMs
    Integer必填

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

    示例： 5000

响应状态

200 OK
200 OK

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

  • reachable
    Boolean

    是否可达。

    示例： true

  • error
    String

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

    示例： connection refused