Hanzo
OpenapiO11y

Lists Kubernetes persistent volume claims with available, capacity and used…

Lists Kubernetes persistent volume claims with available, capacity and used bytes and inode counts, plus the claim's pod, namespace, node, statefulset and…

POST /v1/o11y/infra_monitoring/pvcs

Addresshttps://api.hanzo.ai/v1/o11y/infra_monitoring/pvcs
MethodPOST
Operationpost_o11y_infra_monitoring_pvcs
AuthAuthorization: Bearer $HANZO_API_KEY

Lists Kubernetes persistent volume claims with available, capacity and used bytes and inode counts, plus the claim's pod, namespace, node, statefulset and cluster attributes. Rows answer as 'list' under the default k8s.persistentvolumeclaim.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 six volume 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.O11yInfraVolumesOutok

200 body — 20 fields.

FieldInTypeAlwaysDescription
databodyo11y.Volumes
data.endTimeBeforeRetentionbodyboolean
data.recordsbodyo11y.VolumeRecord[]
data.records[].metabodyobject
data.records[].meta.*bodystring
data.records[].persistentVolumeClaimNamebodystring
data.records[].volumeAvailablebodynumber
data.records[].volumeCapacitybodynumber
data.records[].volumeInodesbodynumber
data.records[].volumeInodesFreebodynumber
data.records[].volumeInodesUsedbodynumber
data.records[].volumeUsagebodynumber
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 pvcs

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page