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

GetZakuOverview

Retrieve aggregated overview statistics for the Zaku platform

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • platformIdString

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

Responses

200 OK

On success, this API returns the following response structure.

  • totalClustersInteger

    Total number of registered clusters

    Example: 5

  • totalNodesInteger

    Total number of nodes across all clusters

    Example: 60

  • totalGpusInteger

    Total number of GPU cards across all clusters

    Example: 128

  • avgGpuUtilizationLong

    Average GPU utilization percentage across all clusters

    Example: 72.5

  • clusterHealthDistributionLinkedHashMap

    Distribution of cluster health statuses

    Example: (nested object)

  • nodeStatusDistributionLinkedHashMap

    Distribution of node statuses across the fleet

    Example: (nested object)

  • nodeRoleDistributionLinkedHashMap

    Distribution of node roles across the fleet

    Example: (nested object)

Endpoint

GET/api/v1/zaku/overview

/api/v1/zaku/overview

Operation ID

GetZakuOverview

Permalink

Request Example

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

Response Example

200
{
  "totalClusters": 5,
  "totalNodes": 60,
  "totalGpus": 128,
  "avgGpuUtilization": 72.5,
  "clusterHealthDistribution": null,
  "nodeStatusDistribution": null,
  "nodeRoleDistribution": null
}

Change History

This API has no change history records yet.

View all change history