Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Zaku
GETZakuSince 1.0SynchronousAuth Required

GetNodeTopology

Get topology of pods and associations for a specific node

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • nodeUuidStringRequired

    UUID of the node to retrieve topology for

Responses

200 OK

On success, this API returns the following response structure.

  • nodeObject

    The node value

    • uuidString

      Unique identifier of the node

      Example: node-xyz789

    • platformIdString

      Platform ID this node belongs to

      Example: plat-001

    • clusterUuidString

      UUID of the cluster this node belongs to

      Example: cluster-abc123

    • nameString

      Hostname of the Kubernetes node

      Example: k8s-node-01

    • nodeIpString

      Primary IP address of the node

      Example: 10.0.1.25

    • roleString

      Role of the node within the cluster (master or worker)

      Example: worker

    • statusString

      Current node status (Ready, NotReady, etc.)

      Example: Ready

    • cpuCapacityInteger

      Total CPU capacity in millicores

      Example: 32000

    • memoryCapacityString

      Total memory capacity in bytes

      Example: 137438953472

    • labelsRawString

      Raw JSON string of Kubernetes node labels

      Example: {"kubernetes.io/role":"worker"}

    • createDateString

      Timestamp when the node was registered

      Example: 2026-01-15T08:00:00Z

    • lastSyncAtString

      Timestamp of the last sync for this node

      Example: 2026-01-15T08:00:00Z

  • podsList

    The pods value

    Example: (nested array)

    • uuidString

      Unique identifier of the pod

      Example: pod-001

    • nameString

      Name of the pod

      Example: nginx-deployment-abc123

    • namespaceString

      Kubernetes namespace of the pod

      Example: default

    • statusString

      Current status phase of the pod

      Example: Running

    • workloadNameString

      Name of the parent workload managing this pod

      Example: nginx-deployment

    • workloadKindString

      Kind of the parent workload (Deployment, StatefulSet, etc.)

      Example: Deployment

    • gpuUuidsList

      UUIDs of GPU cards assigned to this pod

      Example: item1,item2

  • associationsList

    Associations for this resource

    Example: (nested array)

    • assocTypeString

      Type of the cross-platform association

      Example: VirtualMachine

    • assocPlatformIdString

      Platform ID of the associated resource

      Example: plat-002

    • assocUuidString

      UUID of the associated resource in the other platform

      Example: vm-001

    • assocNameString

      Name of the associated resource

      Example: worker-vm-01

    • businessIpv4String

      Business IPv4 address of the associated resource

      Example: 192.168.1.10

Endpoint

GET/api/v1/zaku/nodes/{nodeUuid}/topology

/api/v1/zaku/nodes/{nodeUuid}/topology

Operation ID

GetNodeTopology

Permalink

Request Example

curl -X GET '{host}/api/v1/zaku/nodes/{nodeUuid}/topology' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "node": {},
  "pods": [
    {}
  ],
  "associations": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history