---
title: "query clusters"
method: GET
path: "/clusters/"
tags: ["cluster"]
---

# query clusters

`GET /clusters/`

query clusters

## Query parameters

- `clusterId` string
- `clusterName` string
- `clusterStatus` string
- `clusterTag` string
- `clusterType` string
- `page` integer
- `pageSize` integer

## Response `200`

OK

- object
  - `code` integer
  - `data` object
    - `clusters` StructsClusterInfo[]
      - `alertUrl` string
      - `backupFileUsage` StructsUsage
        - `total` number
        - `usageRate` number
        - `used` number
      - `clusterId` string
      - `clusterName` string
      - `clusterType` string
      - `clusterVersion` string
      - `copies` integer — The number of copies of the newly created cluster data, consistent with the number of copies set in PD
      - `cpuArchitecture` string — X86/X86_64/ARM
      - `cpuUsage` StructsUsage
        - `total` number
        - `usageRate` number
        - `used` number
      - `createTime` string
      - `deleteTime` string
      - `exclusive` boolean — Whether the newly created cluster is exclusive to physical resources, when exclusive, a host will only deploy instances of the same cluster, which may result in poor resource utilization
      - `extranetConnectAddresses` string[]
      - `grafanaUrl` string
      - `intranetConnectAddresses` string[]
      - `maintainStatus` string
      - `maintainWindow` string
      - `memoryUsage` StructsUsage
        - `total` number
        - `usageRate` number
        - `used` number
      - `region` string
      - `relations` StructsClusterRelations
        - `masters` string[]
        - `slaves` string[]
      - `role` string
      - `status` string
      - `storageUsage` StructsUsage
        - `total` number
        - `usageRate` number
        - `used` number
      - `tags` string[]
      - `tls` boolean
      - `updateTime` string
      - `userId` string
      - `vendor` string — DBUser string `json:"dbUser"` //The username and password for the newly created database cluster, default is the root user, which is not valid for Data Migration clusters
      - `whitelist` string[]
  - `message` string
  - `page` ControllerPage
    - `page` integer
    - `pageSize` integer
    - `total` integer

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/pingcap/apis/em-ui-api.md) · [All operations](https://skmtc.net/pingcap/apis/em-ui-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pingcap/em-ui-api/versions/631e4b26b7e8/schema)