---
title: "list all clusters"
method: GET
path: "/api/v1/clusters"
tags: ["cluster"]
---

# list all clusters

`GET /api/v1/clusters`

## Query parameters

- `query` string
- `page` integer
- `pageSize` integer

## Response `200`

OK

- V1ListClusterResponse
  - `clusters` V1ClusterBase[], required
    - `alias` string
    - `apiServerURL` string, required
    - `dashboardURL` string, required
    - `description` string
    - `icon` string
    - `labels` object
    - `name` string, required
    - `providerInfo` ModelProviderInfo, required
      - `clusterID` string, required
      - `clusterName` string
      - `labels` object, required
      - `provider` string, required
      - `regionID` string
      - `vpcID` string
      - `zone` string
      - `zoneID` string
    - `reason` string, required
    - `status` string, required
  - `total` integer, required

## Other responses

- `400` — Bad Request
- `500` — Bummer, something went wrong

---

[API](https://skmtc.net/kubevela/apis/kubevela-api-doc.md) · [All operations](https://skmtc.net/kubevela/apis/kubevela-api-doc/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kubevela/kubevela-api-doc/versions/8e41615b25d5/schema)