Skip to main content
ZStack
Monitoring & Collection/Zaku

GetTopClusters

Retrieve the top clusters ranked by GPU utilization or other metrics

GET/api/v1/zaku/clusters/top

Operation ID

GetTopClusters

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

  • limit
    Integer

    Maximum number of top clusters to return Maximum number of top clusters to return

    Example: 0

  • order
    String

    Sort order field (e.g. gpu_utilization, used_gpus) Sort order field (e.g. gpu_utilization, used_gpus)

  • platformId
    String

    Filter by platform ID; empty returns all platforms Filter by platform ID; empty returns all platforms

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • clusterId
      String

      Identifier of the cluster

      Example: cluster-abc123

    • clusterName
      String

      Name of the cluster

      Example: prod-k8s-cluster-01

    • totalGpus
      Integer

      Total number of GPU cards in the cluster

      Example: 32

    • usedGpus
      Integer

      Number of GPUs currently in use

      Example: 24

    • gpuUtilization
      Long

      GPU utilization ratio as a decimal (0.0 to 1.0)

      Example: 0.75

  • total
    Integer

    Total number of clusters in the result set

    Example: 10