Skip to main content
ZStack
Monitoring & Collection/Zaku

GetZakuOverview

Retrieve aggregated overview statistics for the Zaku platform

GET/api/v1/zaku/overview

Operation ID

GetZakuOverview

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

Query Parameters

  • platformId
    String

    Filter overview by platform ID; empty returns global stats Filter overview by platform ID; empty returns global stats

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • totalClusters
    Integer

    Total number of registered clusters

    Example: 5

  • totalNodes
    Integer

    Total number of nodes across all clusters

    Example: 60

  • totalGpus
    Integer

    Total number of GPU cards across all clusters

    Example: 128

  • avgGpuUtilization
    Long

    Average GPU utilization percentage across all clusters

    Example: 72.5

  • clusterHealthDistribution
    LinkedHashMap

    Distribution of cluster health statuses

    Example: (nested object)

  • nodeStatusDistribution
    LinkedHashMap

    Distribution of node statuses across the fleet

    Example: (nested object)

  • nodeRoleDistribution
    LinkedHashMap

    Distribution of node roles across the fleet

    Example: (nested object)