Skip to main content
API Explorer|API Explorer
Platform Operations/Platform Federation
GETPlatformSince 1.0SynchronousAuth Required

GetGroupOverview

Get a per-cluster resource usage and health overview for a cluster group.

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • groupIdStringRequired

    ID of the cluster group to get an overview for

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Per-cluster overview items within the group

    Example: (nested array)

    • clusterIdString

      UUID of the cluster

      Example: cluster-abc-001

    • clusterNameString

      Human-readable name of the cluster

      Example: prod-cluster-east

    • nodeCountInteger

      Total number of nodes in the cluster

      Example: 10

    • podCountInteger

      Total number of running pods in the cluster

      Example: 256

    • cpuUsagePctLong

      CPU usage as a percentage (0.0 to 100.0)

      Example: 72.5

    • memUsagePctLong

      Memory usage as a percentage (0.0 to 100.0)

      Example: 60

    • alertCountInteger

      Number of active alerts for this cluster

      Example: 2

    • lastSyncAtString

      Last sync at

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

    • statusString

      Current operational status of the cluster

      Example: healthy

Endpoint

GET/api/v1/federation/cluster-groups/{groupId}/overview

/api/v1/federation/cluster-groups/{groupId}/overview

Operation ID

GetGroupOverview

Permalink

Request Example

curl -X GET '{host}/api/v1/federation/cluster-groups/{groupId}/overview' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history