Hanzo
OpenapiO11y

Lists Kubernetes clusters over a time range, each with its CPU and memory usage…

Lists Kubernetes clusters over a time range, each with its CPU and memory usage against allocatable capacity and its attributes; filterable, groupable and…

POST /v1/o11y/clusters/list

Addresshttps://api.hanzo.ai/v1/o11y/clusters/list
MethodPOST
Operationpost_o11y_clusters_list
AuthAuthorization: Bearer $HANZO_API_KEY

Lists Kubernetes clusters over a time range, each with its CPU and memory usage against allocatable capacity and its attributes; filterable, groupable and paginated.

Request

24 fields, body application/json (required).

FieldInTypeRequiredDescription
endbodyintegerepoch time in ms
filtersbodyo11y.FilterSet
filters.itemsbodyo11y.FilterItem[]
filters.items[].keybodyo11y.AttributeKey
filters.items[].key.dataTypebodystring
filters.items[].key.isColumnbodyboolean
filters.items[].key.isJSONbodyboolean
filters.items[].key.keybodystring
filters.items[].key.typebodystring
filters.items[].opbodystring
filters.items[].valuebodyobject
filters.opbodystring
groupBybodyo11y.AttributeKey[]
groupBy[].dataTypebodystring
groupBy[].isColumnbodyboolean
groupBy[].isJSONbodyboolean
groupBy[].keybodystring
groupBy[].typebodystring
limitbodyinteger
offsetbodyinteger
orderBybodyo11y.OrderBy
orderBy.columnNamebodystring
orderBy.orderbodystring
startbodyintegerepoch time in ms

Response

StatusBodyMeaning
200o11y.O11yClusterListOutok

200 body — 12 fields.

FieldInTypeAlwaysDescription
databodyo11y.ClusterListResponse
data.recordsbodyo11y.ClusterListRecord[]
data.records[].clusterUIDbodystring
data.records[].cpuAllocatablebodynumber
data.records[].cpuUsagebodynumber
data.records[].memoryAllocatablebodynumber
data.records[].memoryUsagebodynumber
data.records[].metabodyobject
data.records[].meta.*bodystring
data.totalbodyinteger
data.typebodystring
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y clusters list

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page