Sign in
ClusterService

GetClusters in a cluster

Changed on
get/api/v2/clusters/{clusterId}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

clusterIdstring required

The cluster_id of the host

Response

A successful response.

clusterIdstring required
clusterNamestring
versionstring
archstring
tiupIdstring
tiupNamestring
nodesinteger
cpuinteger
memoryinteger
storageinteger
status'created' | 'destroyed' | 'stopped' | 'running' | 'offlining' | 'offlined'
pdNodesinteger
tidbNodesinteger
tikvNodesinteger
tiflashNodesinteger
alertAllinteger
alertWarninginteger
alertCriticalinteger
alertEmergencyinteger
taskStatus'running' | 'creating' | 'scaling' | 'destroying' | 'reloading' | 'taking' | 'stopping' | 'restarting' | 'starting' | 'offlining' | 'offlined'
taskIdstring
source'create' | 'takeover'
creatorstring
createTimestring date-time

Changes