---
title: "preview cluster topology and capability"
method: POST
path: "/clusters/{clusterId}/preview-scale-out"
tags: ["cluster"]
---

# preview cluster topology and capability

`POST /clusters/{clusterId}/preview-scale-out`

preview cluster topology and capability

## Path parameters

- `clusterId` string, required

## Request body

- ClusterScaleOutClusterReq
  - `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'

## Response `200`

OK

- object
  - `code` integer
  - `data` object
    - `capabilityIndexes` StructsIndex[]
      - `description` string
      - `name` string
      - `unit` string
      - `value` object
    - `clusterName` string
    - `clusterType` string
    - `clusterVersion` string
    - `cpuArchitecture` string
    - `region` string
    - `stockCheckResult` StructsResourceStockCheckResult[]
      - `componentName` string
      - `componentType` string
      - `count` integer
      - `diskCapacity` integer
      - `diskId` string
      - `diskType` string — NVMeSSD/SSD/SATA
      - `enough` boolean
      - `hostIp` string
      - `specCode` string — 4C8G/8C16G ?
      - `zoneCode` string
  - `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)