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

GetTopClusters

Retrieve the top clusters ranked by GPU utilization or other metrics

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • limitInteger

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

    Example: 0

  • orderString

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

  • platformIdString

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

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • clusterIdString

      Identifier of the cluster

      Example: cluster-abc123

    • clusterNameString

      Name of the cluster

      Example: prod-k8s-cluster-01

    • totalGpusInteger

      Total number of GPU cards in the cluster

      Example: 32

    • usedGpusInteger

      Number of GPUs currently in use

      Example: 24

    • gpuUtilizationLong

      GPU utilization ratio as a decimal (0.0 to 1.0)

      Example: 0.75

  • totalInteger

    Total number of clusters in the result set

    Example: 10

Endpoint

GET/api/v1/zaku/clusters/top

/api/v1/zaku/clusters/top

Operation ID

GetTopClusters

Permalink

Request Example

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

Response Example

200
{
  "items": [
    {}
  ],
  "total": 10
}

Change History

This API has no change history records yet.

View all change history