Skip to main content
ZStack
Settings/Chrony Servers Operations

CheckNetworkReachable

CheckNetworkReachable

GET/zstack/v1/zops/check/network

Operation ID

CheckNetworkReachable

Since

4.7.21

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

Query Parameters

  • sourceHostnames
    List

    Optional. Specified set of source ip addresses or domain names.

  • targetHostnames
    ListRequired

    Specified set of target ip addresses or domain names.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • success
    booleanRequired

    Whether the operation succeeded.

  • error
    ErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • results
    ListRequired

    See results.

    • sourceHostname
      StringRequired

      The source address.

    • targetHostname
      StringRequired

      The target address.

    • status
      HostConnectedStatusRequired

      See status.

      • Connected
        HostConnectedStatusRequired

        The networke is connected.

      • Disconnected
        HostConnectedStatusRequired

        The networke is disconnected.

      • Unknown
        HostConnectedStatusRequired

        The network status is unknown.