跳转到主要内容
API Explorer|API Explorer
平台运维相关接口/平台管理
POSTPlatform起始版本 1.0同步需要认证

测试连接详情

运行步骤连接测试返回步骤诊断。

调试可用性

在线调试

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

请求参数

请求体字段

  • productTypeString必填

    产品类型。

    示例： zstack

  • endpointString必填

    接收端地址。

    示例： 192.168.1.100:8080

  • accessKeyString必填

    ID认证。

    示例： AKID1234567890

  • secretKeyString必填

    密钥。脱敏显示时不返回明文。

    示例： secret-value-xyz

响应状态

200 OK

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

  • successBoolean

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

    示例： true

  • itemsList

    条目列表。

    示例： (nested array)

    • nameString

      资源名称。

      示例： tcp_connect

    • statusString

      状态信息。

      示例： success

    • latencyMsString

      时延，单位为毫秒。

      示例： 45

    • errorMsgString

      错误消息。

      示例： connection refused

  • recommendationString

    建议信息。

    示例： Check firewall rules for port 8080

请求地址

POST/api/v1/platforms/test-connection

/api/v1/platforms/test-connection

操作 ID

TestConnectionDetailed

永久链接

请求示例

curl -X POST '{host}/api/v1/platforms/test-connection' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"key": "value"}'

响应示例

200
{
  "success": true,
  "items": [
    {}
  ],
  "recommendation": "Check firewall rules for port 8080"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史