Skip to main content
ZStack
Platform Operations/Platforms

TestConnectionDetailed

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

POST/api/v1/platforms/test-connection

Operation ID

TestConnectionDetailed

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • productType
    StringRequired

    Product type of the platform to test

    Example: zstack

  • endpoint
    StringRequired

    Endpoint URL or host:port of the platform

    Example: 192.168.1.100:8080

  • accessKey
    StringRequired

    Access key ID for authentication

    Example: AKID1234567890

  • secretKey
    StringRequired

    Secret key for authentication

    Example: secret-value-xyz

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • success
    Boolean

    Whether the overall connection test passed

    Example: true

  • items
    List

    Ordered list of step-by-step test results

    Example: (nested array)

    • name
      String

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

      Example: tcp_connect

    • status
      String

      Step result status (success, failure)

      Example: success

    • latencyMs
      String

      Latency in milliseconds for this step

      Example: 45

    • errorMsg
      String

      Error message if this step failed

      Example: connection refused

  • recommendation
    String

    Actionable recommendation to resolve any failures

    Example: Check firewall rules for port 8080

  • productType
    String

    Product type that was tested

    Example: zns

  • scope
    String

    Connection scope resolved for the tested product

    Example: global

  • regionUuid
    String

    Region UUID resolved for the tested product. Empty for global products

    Example: value

  • sourceDetection
    String

    Source detection mode. ZNS is not source-detected in this release

    Example: not_applicable

Change History

View all change history

  • Change Time

    AddedResponse fields productType, regionUuid, scope...
    View API