# Create clusters

URL: https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-infra-monitoring-clusters

> Lists Kubernetes clusters with CPU and memory usage against allocatable capacity summed over their nodes, plus per-group node readiness and pod phase counts.

`POST /v1/o11y/infra_monitoring/clusters`

> [O11y →](https://docs.hanzo.ai/docs/openapi/o11y) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                          |
| ------------- | -------------------------------------------------------- |
| **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 (int64)                  | —        |                                                     |
| `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 (int64)                  | —        |                                                     |
| `offset`                    | body | integer (int64)                  | —        |                                                     |
| `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 (int64)                  | —        |                                                     |

## Response

| Status    | Body                      | Meaning           |
| --------- | ------------------------- | ----------------- |
| `200`     | o11y.O11yInfraClustersOut | ok                |
| `202`     | Approval                  | held for approval |
| `default` | problem-details           | refused           |

`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 (double)                 | —      |                                                                                                                                                                      |
| `data.records[].clusterCPUAllocatable`          | body | number (double)                 | —      |                                                                                                                                                                      |
| `data.records[].clusterMemory`                  | body | number (double)                 | —      |                                                                                                                                                                      |
| `data.records[].clusterMemoryAllocatable`       | body | number (double)                 | —      |                                                                                                                                                                      |
| `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) ClusterName. |
| `data.records[].meta`                           | body | object                          | —      |                                                                                                                                                                      |
| `data.records[].meta.*`                         | body | string                          | —      |                                                                                                                                                                      |
| `data.records[].nodeCountsByReadiness`          | body | o11y.NodeCountsByReadiness      | —      |                                                                                                                                                                      |
| `data.records[].nodeCountsByReadiness.notReady` | body | integer (int64)                 | —      |                                                                                                                                                                      |
| `data.records[].nodeCountsByReadiness.ready`    | body | integer (int64)                 | —      |                                                                                                                                                                      |
| `data.records[].podCountsByPhase`               | body | o11y.PodCountsByPhase           | —      |                                                                                                                                                                      |
| `data.records[].podCountsByPhase.failed`        | body | integer (int64)                 | —      |                                                                                                                                                                      |
| `data.records[].podCountsByPhase.pending`       | body | integer (int64)                 | —      |                                                                                                                                                                      |
| `data.records[].podCountsByPhase.running`       | body | integer (int64)                 | —      |                                                                                                                                                                      |
| `data.records[].podCountsByPhase.succeeded`     | body | integer (int64)                 | —      |                                                                                                                                                                      |
| `data.records[].podCountsByPhase.unknown`       | body | integer (int64)                 | —      |                                                                                                                                                                      |
| `data.total`                                    | body | integer (int64)                 | —      |                                                                                                                                                                      |
| `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](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo o11y infra_monitoring clusters
```

**SDK**

**.ts**

```ts
import { 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>"} });
```

**.py**

```python
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>"})
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.PostO11yInfraMonitoringClusters(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::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?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new O11yApi(client).postO11yInfraMonitoringClusters();
```

**HTTP**

```bash
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>"
       }
     }'
```

**MCP**

MCP reaches **o11y** through the `o11y` tool, which names its 307 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
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": "list_o11y_autocomplete_aggregate_attributes"
         }
       }
     }'
```

---

[O11y API](https://docs.hanzo.ai/docs/openapi/o11y) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
