Hanzo
OpenapiO11y

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

Lists Kubernetes jobs with the CPU and memory their pods used against request and limit, the latest desired-successful, active, failed and successful pod…

POST /v1/o11y/infra_monitoring/jobs

Addresshttps://api.hanzo.ai/v1/o11y/infra_monitoring/jobs
MethodPOST
Operationpost_o11y_infra_monitoring_jobs
AuthAuthorization: Bearer $HANZO_API_KEY

Lists Kubernetes jobs with the CPU and memory their pods used against request and limit, the latest desired-successful, active, failed and successful pod counters, and per-group pod phase counts — the phase counts are current state while the counters are cumulative over the job's life. Rows answer as 'list' under the default k8s.job.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 job counters, 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.O11yInfraJobsOutok

200 body — 30 fields.

FieldInTypeAlwaysDescription
databodyo11y.Jobs
data.endTimeBeforeRetentionbodyboolean
data.recordsbodyo11y.JobRecord[]
data.records[].activePodsbodyinteger
data.records[].desiredSuccessfulPodsbodyinteger
data.records[].failedPodsbodyinteger
data.records[].jobCPUbodynumber
data.records[].jobCPULimitbodynumber
data.records[].jobCPURequestbodynumber
data.records[].jobMemorybodynumber
data.records[].jobMemoryLimitbodynumber
data.records[].jobMemoryRequestbodynumber
data.records[].jobNamebodystring
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.records[].successfulPodsbodyinteger
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 jobs

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page