Skip to main content
ZStack
Monitoring & Collection/Monitoring Query & Overview

GetTopologyTree

Return a recursive topology tree rooted at the specified resource

GET/api/v1/monitoring/topology/tree/{type}/{uuid}

Operation ID

GetTopologyTree

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

Path Parameters

  • type
    StringRequired

    Resource type to root the topology tree at (e.g. cluster, host)

  • uuid
    StringRequired

    UUID of the root resource

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • uuid
    String

    Unique identifier of this topology node

    Example: cluster-001

  • name
    String

    Display name of this topology node

    Example: Production Cluster

  • type
    String

    Resource type of this node (e.g. cluster, host, vm)

    Example: cluster

  • state
    String

    Current state of this topology node

    Example: online

  • children
    List

    Children for this resource

    Example: (nested array)

    • uuid
      String

      Unique identifier of this topology node

      Example: cluster-001

    • name
      String

      Display name of this topology node

      Example: Production Cluster

    • type
      String

      Resource type of this node (e.g. cluster, host, vm)

      Example: cluster

    • state
      String

      Current state of this topology node

      Example: online

    • children
      List

      Children for this resource

      Example: (nested array)