Skip to main content
API Explorer|API Explorer
Platform Operations/Platforms
POSTPlatformSince 1.0SynchronousAuth Required

TestConnectionDetailed

Run a step-by-step connection test and return per-step diagnostics.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • productTypeStringRequired

    Product type of the platform to test

    Example: zstack

  • endpointStringRequired

    Endpoint URL or host:port of the platform

    Example: 192.168.1.100:8080

  • accessKeyStringRequired

    Access key ID for authentication

    Example: AKID1234567890

  • secretKeyStringRequired

    Secret key for authentication

    Example: secret-value-xyz

Responses

200 OK

On success, this API returns the following response structure.

  • successBoolean

    Whether the overall connection test passed

    Example: true

  • itemsList

    Ordered list of step-by-step test results

    Example: (nested array)

    • nameString

      Name of the test step (e.g. dns_lookup, tcp_connect)

      Example: tcp_connect

    • statusString

      Step result status (success, failure)

      Example: success

    • latencyMsString

      Latency in milliseconds for this step

      Example: 45

    • errorMsgString

      Error message if this step failed

      Example: connection refused

  • recommendationString

    Actionable recommendation to resolve any failures

    Example: Check firewall rules for port 8080

Endpoint

POST/api/v1/platforms/test-connection

/api/v1/platforms/test-connection

Operation ID

TestConnectionDetailed

Permalink

Request Example

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

Response Example

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

Change History

This API has no change history records yet.

View all change history