GRgravitee-io
Clusters

Count clusters by lifecycle state

Changed on

Returns the total number of clusters and the count per lifecycle state (Deployed / Pending / Undeployed) for the environment, optionally scoped to a cluster type — the numbers behind the console cluster stat-strip. User must have the ENVIRONMENT_CLUSTER[READ] permission.

get/clusters/_stats

Request

  • Base URL
    /management/v2/environments/DEFAULT (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /management/v2/environments/DEFAULT/clusters/_stats
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Query parameters

type'KAFKA_CLUSTER_STANDALONE' | 'KAFKA_CLUSTER' | 'KAFKA_VIRTUAL_CLUSTER'

Filter clusters by type.

Response

Cluster counts by lifecycle state

totalinteger

Total number of clusters.

deployedinteger

Number of clusters in the DEPLOYED state.

pendinginteger

Number of clusters in the PENDING state.

undeployedinteger

Number of clusters in the UNDEPLOYED state.

Changes