Hanzo
OpenapiO11y

Lists Kubernetes pods with CPU and memory usage against request and limit, the…

Lists Kubernetes pods with CPU and memory usage against request and limit, the pod's phase and its age, plus its namespace, node, owning workload and…

POST /v1/o11y/infra_monitoring/pods

Addresshttps://api.hanzo.ai/v1/o11y/infra_monitoring/pods
MethodPOST
Operationpost_o11y_infra_monitoring_pods
AuthAuthorization: Bearer $HANZO_API_KEY

Lists Kubernetes pods with CPU and memory usage against request and limit, the pod's phase and its age, plus its namespace, node, owning workload and cluster attributes. Rows answer as 'list' under the default k8s.pod.uid grouping (each row one pod) or 'grouped_list' under a custom groupBy (each row aggregating its pods with per-phase counts); a metric with no data in the window answers -1. Filterable by expression, orderable by the six pod metrics, 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.O11yInfraPodsOutok

200 body — 28 fields.

FieldInTypeAlwaysDescription
databodyo11y.Pods
data.endTimeBeforeRetentionbodyboolean
data.recordsbodyo11y.PodRecord[]
data.records[].metabodyobject
data.records[].meta.*bodystring
data.records[].podAgebodyinteger
data.records[].podCPUbodynumber
data.records[].podCPULimitbodynumber
data.records[].podCPURequestbodynumber
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.records[].podMemorybodynumber
data.records[].podMemoryLimitbodynumber
data.records[].podMemoryRequestbodynumber
data.records[].podPhasebodyany
data.records[].podUIDbodystring
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 pods

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page