---
name: query-clusters
description: List clusters, get cluster details, view topology, and view components.
---

# Available Actions

## List Clusters

List clusters with optional filters.

API Path: `/clusters`.

Method: `GET`.

### Query parameters

- `page` (integer, optional): page number. Default: `1`. Must be greater than `0`.
- `per_page` (integer, optional): number of items per page. Default: `100`. Must be greater than `0` and less than or equal to `100`.
- `tenant_id` (string[], optional): filter by one or more tenant IDs.
- `project_id` (string[], optional): filter by one or more project IDs.
- `cluster_id` (string[], optional): filter by one or more cluster IDs.
- `deploy_type` (string, optional): filter by deploy type.
- `is_resource_pool` (boolean, optional): if `true`, list resource pools instead of custom clusters.
- `service_plan` (string, optional): filter by service plan.

## Get Cluster

Get detailed information about a specific cluster.

API Path: `/clusters/{cluster_id}`.

Method: `GET`.

## Get Cluster Topology

Retrieve the topology of a specific cluster.

API Path: `/clusters/{cluster_id}/topology`.

Method: `GET`.

## Get Cluster Components

Retrieve all component details of a specific cluster.

API Path: `/clusters/{cluster_id}/components`.

Method: `GET`.