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

GetVMHierarchy

Get the full resource hierarchy for a virtual machine (VM → host → cluster → zone)

GET/api/v1/monitoring/topology/vm/{uuid}/hierarchy

Operation ID

GetVMHierarchy

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

  • uuid
    StringRequired

    UUID of the virtual machine to retrieve hierarchy for

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • vm
    Object

    The vm value

    • uuid
      String

      Unique identifier of the resource

      Example: res-abc-001

    • name
      String

      Display name of the resource

      Example: primary-host-01

    • state
      String

      Current state of the resource (e.g. running, stopped, error)

      Example: running

    • type
      String

      Resource type (e.g. vm, host, cluster, zone)

      Example: host

  • host
    Object

    The host value

    • uuid
      String

      Unique identifier of the resource

      Example: res-abc-001

    • name
      String

      Display name of the resource

      Example: primary-host-01

    • state
      String

      Current state of the resource (e.g. running, stopped, error)

      Example: running

    • type
      String

      Resource type (e.g. vm, host, cluster, zone)

      Example: host

  • cluster
    Object

    Cluster for this resource

    • uuid
      String

      Unique identifier of the resource

      Example: res-abc-001

    • name
      String

      Display name of the resource

      Example: primary-host-01

    • state
      String

      Current state of the resource (e.g. running, stopped, error)

      Example: running

    • type
      String

      Resource type (e.g. vm, host, cluster, zone)

      Example: host

  • zone
    Object

    The zone value

    • uuid
      String

      Unique identifier of the resource

      Example: res-abc-001

    • name
      String

      Display name of the resource

      Example: primary-host-01

    • state
      String

      Current state of the resource (e.g. running, stopped, error)

      Example: running

    • type
      String

      Resource type (e.g. vm, host, cluster, zone)

      Example: host