---
title: "show details of a cluster"
method: GET
path: "/clusters/{clusterId}"
tags: ["cluster"]
---

# show details of a cluster

`GET /clusters/{clusterId}`

show details of a cluster

## Path parameters

- `clusterId` string, required

## Response `200`

OK

- object
  - `code` integer
  - `data` object
    - `info` 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[]
    - `instanceResource` StructsClusterResourceParameterCompute[]
      - `componentType` string — TiDB/TiKV/PD/TiFlash/CDC/DM-Master/DM-Worker
      - `resource` StructsClusterResourceParameterComputeResource[]
        - `count` integer
        - `diskCapacity` integer
        - `diskId` string
        - `diskType` string — NVMeSSD/SSD/SATA
        - `hostIp` string
        - `specCode` string — 4C8G/8C16G ?
        - `zoneCode` string
      - `totalNodeCount` integer
    - `requestResourceMode` 'SpecificZone' | 'SpecificHost'
    - `topology` StructsClusterInstanceInfo[]
      - `addresses` string[]
      - `cpuUsage` StructsUsage
        - `total` number
        - `usageRate` number
        - `used` number
      - `diskId` string
      - `hostID` string
      - `id` string
      - `ioUtil` number
      - `iops` number[]
      - `memoryUsage` StructsUsage
        - `total` number
        - `usageRate` number
        - `used` number
      - `ports` integer[]
      - `role` string
      - `spec` StructsProductSpecInfo
        - `id` string
        - `name` string
      - `status` string
      - `storageUsage` StructsUsage
        - `total` number
        - `usageRate` number
        - `used` number
      - `type` string
      - `version` string
      - `zone` StructsZoneFullInfo
        - `comment` string
        - `regionId` string — The value of the RegionID is similar to CN-HANGZHOU
        - `regionName` string — The value of the Name is similar to East China(Hangzhou)
        - `vendorId` string — The value of the VendorID is similar to AWS
        - `vendorName` string — The value of the Name is similar to AWS
        - `zoneId` string — The value of the ZoneID is similar to CN-HANGZHOU-H
        - `zoneName` string — The value of the Name is similar to Hangzhou(H)
  - `message` string

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