# List clusters

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

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

`POST /v1/o11y/clusters/list`

> [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/clusters/list` |
| **Method**    | `POST`                                       |
| **Operation** | `post_o11y_clusters_list`                    |
| **Auth**      | `Authorization: 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).

| Field                          | In   | Type                 | Required | Description      |
| ------------------------------ | ---- | -------------------- | -------- | ---------------- |
| `end`                          | body | integer (int64)      | —        | epoch time in ms |
| `filters`                      | body | o11y.FilterSet       | —        |                  |
| `filters.items`                | body | o11y.FilterItem\[]   | —        |                  |
| `filters.items[].key`          | body | o11y.AttributeKey    | —        |                  |
| `filters.items[].key.dataType` | body | string               | —        |                  |
| `filters.items[].key.isColumn` | body | boolean              | —        |                  |
| `filters.items[].key.isJSON`   | body | boolean              | —        |                  |
| `filters.items[].key.key`      | body | string               | —        |                  |
| `filters.items[].key.type`     | body | string               | —        |                  |
| `filters.items[].op`           | body | string               | —        |                  |
| `filters.items[].value`        | body | any                  | —        |                  |
| `filters.op`                   | body | string               | —        |                  |
| `groupBy`                      | body | o11y.AttributeKey\[] | —        |                  |
| `groupBy[].dataType`           | body | string               | —        |                  |
| `groupBy[].isColumn`           | body | boolean              | —        |                  |
| `groupBy[].isJSON`             | body | boolean              | —        |                  |
| `groupBy[].key`                | body | string               | —        |                  |
| `groupBy[].type`               | body | string               | —        |                  |
| `limit`                        | body | integer (int64)      | —        |                  |
| `offset`                       | body | integer (int64)      | —        |                  |
| `orderBy`                      | body | o11y.OrderBy         | —        |                  |
| `orderBy.columnName`           | body | string               | —        |                  |
| `orderBy.order`                | body | string               | —        |                  |
| `start`                        | body | integer (int64)      | —        | epoch time in ms |

## Response

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

`200` body — 12 fields.

| Field                              | In   | Type                      | Always | Description          |
| ---------------------------------- | ---- | ------------------------- | ------ | -------------------- |
| `data`                             | body | o11y.ClusterListResponse  | —      |                      |
| `data.records`                     | body | o11y.ClusterListRecord\[] | —      |                      |
| `data.records[].clusterUID`        | body | string                    | —      |                      |
| `data.records[].cpuAllocatable`    | body | number (double)           | —      |                      |
| `data.records[].cpuUsage`          | body | number (double)           | —      |                      |
| `data.records[].memoryAllocatable` | body | number (double)           | —      |                      |
| `data.records[].memoryUsage`       | body | number (double)           | —      |                      |
| `data.records[].meta`              | body | object                    | —      |                      |
| `data.records[].meta.*`            | body | string                    | —      |                      |
| `data.total`                       | body | integer (int64)           | —      |                      |
| `data.type`                        | 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 clusters list
```

**SDK**

**.ts**

```ts
import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postO11yClustersList({ end: 0, filters: {"items":[{"key":{"dataType":null,"isColumn":null,"isJSON":null,"key":null},"op":"<op>","value":"<value>"}],"op":"<op>"} });
```

**.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_clusters_list(end=0, filters={"items":[{"key":{"dataType":null,"isColumn":null,"isJSON":null,"key":null},"op":"<op>","value":"<value>"}],"op":"<op>"})
```

**.go**

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

resp, _, err := client.O11yAPI.PostO11yClustersList(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_clusters_list(&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).postO11yClustersList();
```

**HTTP**

```bash
curl -X POST https://api.hanzo.ai/v1/o11y/clusters/list \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "end": 0,
       "filters": {
         "items": [
           {
             "key": {
               "dataType": null,
               "isColumn": null,
               "isJSON": null,
               "key": null
             },
             "op": "<op>",
             "value": "<value>"
           }
         ],
         "op": "<op>"
       }
     }'
```

**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)
