Hanzo
OpenapiO11y

Lists Kubernetes deployments with the CPU and memory their pods used against…

Lists Kubernetes deployments with the CPU and memory their pods used against request and limit, the latest desired and available replica counts, and…

POST /v1/o11y/infra_monitoring/deployments

Addresshttps://api.hanzo.ai/v1/o11y/infra_monitoring/deployments
MethodPOST
Operationpost_o11y_infra_monitoring_deployments
AuthAuthorization: Bearer $HANZO_API_KEY

Lists Kubernetes deployments with the CPU and memory their pods used against request and limit, the latest desired and available replica counts, and per-group pod phase counts. Rows answer as 'list' under the default k8s.deployment.name grouping or 'grouped_list' under a custom groupBy; a metric with no data in the window answers -1. Filterable by expression, orderable by the pod metrics or the replica counts, 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.O11yInfraDeploymentsOutok

200 body — 28 fields.

FieldInTypeAlwaysDescription
databodyo11y.Deployments
data.endTimeBeforeRetentionbodyboolean
data.recordsbodyo11y.DeploymentRecord[]
data.records[].availablePodsbodyinteger
data.records[].deploymentCPUbodynumber
data.records[].deploymentCPULimitbodynumber
data.records[].deploymentCPURequestbodynumber
data.records[].deploymentMemorybodynumber
data.records[].deploymentMemoryLimitbodynumber
data.records[].deploymentMemoryRequestbodynumber
data.records[].deploymentNamebodystring
data.records[].desiredPodsbodyinteger
data.records[].metabodyobject
data.records[].meta.*bodystring
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 deployments

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page