Lists Kubernetes clusters with CPU and memory usage against allocatable…
Lists Kubernetes clusters with CPU and memory usage against allocatable capacity summed over their nodes, plus per-group node readiness and pod phase…
POST /v1/o11y/infra_monitoring/clusters
| Address | https://api.hanzo.ai/v1/o11y/infra_monitoring/clusters |
| Method | POST |
| Operation | post_o11y_infra_monitoring_clusters |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Lists Kubernetes clusters with CPU and memory usage against allocatable capacity summed over their nodes, plus per-group node readiness and pod phase counts. Rows answer as 'list' under the default k8s.cluster.name grouping or 'grouped_list' under a custom groupBy; a metric with no data in the window answers -1. Filterable by expression, orderable by usage or allocatable, paginated by offset and limit.
Request
22 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
end | body | integer | — | |
filter | body | o11y.Filter | — | |
filter.expression | body | string | — | expression to filter by following the filter syntax |
groupBy | body | o11y.GroupByKey[] | — | |
groupBy[].description | body | string | — | |
groupBy[].fieldContext | body | any | — | |
groupBy[].fieldDataType | body | any | — | |
groupBy[].name | body | string | yes | |
groupBy[].signal | body | any | — | |
groupBy[].unit | body | string | — | |
limit | body | integer | — | |
offset | body | integer | — | |
orderBy | body | o11y.querybuildertypesv5.OrderBy | — | |
orderBy.direction | body | any | — | direction to order by |
orderBy.key | body | o11y.OrderByKey | — | |
orderBy.key.description | body | string | — | |
orderBy.key.fieldContext | body | any | — | |
orderBy.key.fieldDataType | body | any | — | |
orderBy.key.name | body | string | yes | |
orderBy.key.signal | body | any | — | |
orderBy.key.unit | body | string | — | |
start | body | integer | — |
Response
| Status | Body | Meaning |
|---|---|---|
200 | o11y.O11yInfraClustersOut | ok |
200 body — 27 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | o11y.Clusters | — | |
data.endTimeBeforeRetention | body | boolean | — | |
data.records | body | o11y.ClusterRecord[] | — | |
data.records[].clusterCPU | body | number | — | |
data.records[].clusterCPUAllocatable | body | number | — | |
data.records[].clusterMemory | body | number | — | |
data.records[].clusterMemoryAllocatable | body | number | — | |
data.records[].clusterName | body | string | — | TODO(nikhilmantri0902): once the underlying attr key is migrated to k8s.cluster.uid (see ClusterNameAttrKey), surface ClusterUID alongside (or replace)… |
data.records[].meta | body | object | — | |
data.records[].meta.* | body | string | — | |
data.records[].nodeCountsByReadiness | body | o11y.NodeCountsByReadiness | — | |
data.records[].nodeCountsByReadiness.notReady | body | integer | — | |
data.records[].nodeCountsByReadiness.ready | body | integer | — | |
data.records[].podCountsByPhase | body | o11y.PodCountsByPhase | — | |
data.records[].podCountsByPhase.failed | body | integer | — | |
data.records[].podCountsByPhase.pending | body | integer | — | |
data.records[].podCountsByPhase.running | body | integer | — | |
data.records[].podCountsByPhase.succeeded | body | integer | — | |
data.records[].podCountsByPhase.unknown | body | integer | — | |
data.total | body | integer | — | |
data.type | body | any | — | |
data.warning | body | o11y.QueryWarnData | — | |
data.warning.message | body | string | — | |
data.warning.url | body | string | — | |
data.warning.warnings | body | o11y.QueryWarnDataAdditional[] | — | |
data.warning.warnings[].message | body | string | — | |
status | body | string | — | Status is "success". |
Failure carries the platform error shape — see Errors.
Examples
hanzo o11y infra_monitoring clustersimport { Configuration, O11yApi } from 'hanzoai';
const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postO11yInfraMonitoringClusters({ end: 0, filter: {"expression":"<expression>"} });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).post_o11y_infra_monitoring_clusters(end=0, filter={"expression":"<expression>"})cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.O11yAPI.PostO11yInfraMonitoringClusters(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, o11y_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = o11y_api::post_o11y_infra_monitoring_clusters(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new O11yApi(client).postO11yInfraMonitoringClusters();curl -X POST https://api.hanzo.ai/v1/o11y/infra_monitoring/clusters \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"end": 0,
"filter": {
"expression": "<expression>"
}
}'The door reaches o11y through the o11y tool, which names its 340 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "get_o11y_alert_last"
}
}
}'How is this guide?