跳转到主要内容
ZStack
平台运维相关接口/平台管理

测试连接创建

测试保存前的平台连接请求。

POST/api/v1/platforms/actions/test-connection

操作 ID

TestConnectionForCreate

起始版本

1.2.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • productType
    String必填

    产品类型。

    示例： zns

  • hostIp
    String必填

    主机IP地址。

    示例： 172.31.6.104

  • hostPort
    Integer必填

    主机端口。

    示例： 7278

  • username
    String必填

    用户名。

    示例： zcf-federation-admin

  • password
    String必填

    密码。

    示例： s3cret

响应状态

200 OK
200 OK

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

  • success
    Boolean

    操作是否成功。true 表示成功，false 表示失败。

    示例： true

  • items
    List

    条目列表。

    示例： (nested array)

    • name
      String

      资源名称。

      示例： tcp_connect

    • status
      String

      状态信息。

      示例： success

    • latencyMs
      String

      时延，单位为毫秒。

      示例： 45

    • errorMsg
      String

      错误消息。

      示例： connection refused

  • recommendation
    String

    建议信息。

    示例： Check firewall rules for port 8080

  • productType
    String

    产品类型。

    示例： zns

  • scope
    String

    作用范围。

    示例： global

  • regionUuid
    String

    区域UUID。

    示例： value

  • sourceDetection
    String

    源检测。

    示例： not_applicable