Hanzo
OpenapiO11y

Lists Kubernetes clusters with CPU and memory usage against allocatable…

Lists Kubernetes clusters with CPU and memory usage against allocatable capacity summed over their nodes, plus per-group node readiness and pod phase…

POST /v1/o11y/infra_monitoring/clusters

Addresshttps://api.hanzo.ai/v1/o11y/infra_monitoring/clusters
MethodPOST
Operationpost_o11y_infra_monitoring_clusters
AuthAuthorization: Bearer $HANZO_API_KEY

Lists Kubernetes clusters with CPU and memory usage against allocatable capacity summed over their nodes, plus per-group node readiness and pod phase counts. Rows answer as 'list' under the default k8s.cluster.name grouping or 'grouped_list' under a custom groupBy; a metric with no data in the window answers -1. Filterable by expression, orderable by usage or allocatable, paginated by offset and limit.

Request

22 fields, body application/json (required).

FieldInTypeRequiredDescription
endbodyinteger
filterbodyo11y.Filter
filter.expressionbodystringexpression to filter by following the filter syntax
groupBybodyo11y.GroupByKey[]
groupBy[].descriptionbodystring
groupBy[].fieldContextbodyany
groupBy[].fieldDataTypebodyany
groupBy[].namebodystringyes
groupBy[].signalbodyany
groupBy[].unitbodystring
limitbodyinteger
offsetbodyinteger
orderBybodyo11y.querybuildertypesv5.OrderBy
orderBy.directionbodyanydirection to order by
orderBy.keybodyo11y.OrderByKey
orderBy.key.descriptionbodystring
orderBy.key.fieldContextbodyany
orderBy.key.fieldDataTypebodyany
orderBy.key.namebodystringyes
orderBy.key.signalbodyany
orderBy.key.unitbodystring
startbodyinteger

Response

StatusBodyMeaning
200o11y.O11yInfraClustersOutok

200 body — 27 fields.

FieldInTypeAlwaysDescription
databodyo11y.Clusters
data.endTimeBeforeRetentionbodyboolean
data.recordsbodyo11y.ClusterRecord[]
data.records[].clusterCPUbodynumber
data.records[].clusterCPUAllocatablebodynumber
data.records[].clusterMemorybodynumber
data.records[].clusterMemoryAllocatablebodynumber
data.records[].clusterNamebodystringTODO(nikhilmantri0902): once the underlying attr key is migrated to k8s.cluster.uid (see ClusterNameAttrKey), surface ClusterUID alongside (or replace)…
data.records[].metabodyobject
data.records[].meta.*bodystring
data.records[].nodeCountsByReadinessbodyo11y.NodeCountsByReadiness
data.records[].nodeCountsByReadiness.notReadybodyinteger
data.records[].nodeCountsByReadiness.readybodyinteger
data.records[].podCountsByPhasebodyo11y.PodCountsByPhase
data.records[].podCountsByPhase.failedbodyinteger
data.records[].podCountsByPhase.pendingbodyinteger
data.records[].podCountsByPhase.runningbodyinteger
data.records[].podCountsByPhase.succeededbodyinteger
data.records[].podCountsByPhase.unknownbodyinteger
data.totalbodyinteger
data.typebodyany
data.warningbodyo11y.QueryWarnData
data.warning.messagebodystring
data.warning.urlbodystring
data.warning.warningsbodyo11y.QueryWarnDataAdditional[]
data.warning.warnings[].messagebodystring
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y infra_monitoring clusters

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page