PIpingcap
cluster

preview cluster topology and capability

preview cluster topology and capability

post/clusters/preview

Request

  • Base URL
    https://localhost:4100/api/v1
  • URL
    https://localhost:4100/api/v1/clusters/preview
  • Auth
    API key in header Authorization

Request body

clusterNamestring required
clusterTypestring required
clusterVersionstring required
copiesinteger

The number of copies of the newly created cluster data, consistent with the number of copies set in PD

cpuArchitecturestring required

X86/X86_64/ARM

dbPasswordstring required
dbUserstring

todo delete?

exclusiveboolean

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

parameterGroupIDstring
regionstring required

The Region where the cluster is located

tagsstring[]
tlsboolean
vendorstring

Response

OK

codeinteger
messagestring

Changes

No recorded changes to this operation across all 50 revisions of this API.