[{"label":"Latest (v1.1)","version":"latest"}]
vmc

Get Cluster Configure

Description

This API provides the storage choices available when reconfiguring storage in a cluster. The constraints returned will give vSAN reconfiguration biases and available vSAN capacities per reconfiguration bias. The constraints also indicate the default vSAN capacity per reconfiguration biases as well as the default reconfiguration bias.

Request

Request

URL

URL


get
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/clusters/{cluster}/config/constraints
Copy

Path Parameters

Path Parameters

string
org Required

Organization identifier


string
sddc Required

Sddc identifier


string
cluster Required

cluster identifier


Query Parameters

Query Parameters

integer
expected_num_hosts Optional

The expected number of hosts in the cluster. If not specified, returned is based on current number of hosts in the cluster.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns VsanClusterReconfigConstraints of type(s) application/json
available_capacities Required

A map of VsanClusterReconfigBias id to the list of VsanAvailableCapacity. It gives all of available vSAN capacities for each of reconfiguration biases.


default_capacities Required

A map of VsanClusterReconfigBias id to a VsanAvailableCapacity. It gives the default VsanAvailableCapacity for each of reconfiguration biases.


string
default_reconfig_bias_id Required

The id of default VsanClusterReconfigBias for this constraints.


integer as int32
hosts Required

The number of hosts in a cluster for the constraints.


reconfig_biases Required

Biases to reconfigure vSAN in an existing cluster.

Errors

Errors

400

Invalid or missing parameters


401

Unauthorized


403

Forbidden

Code Samples

Code Samples

cURL Command

curl https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/clusters/{cluster}/config/constraints
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmc-ui-servicename: clusterConfigure
x-vmw-vapi-methodname: get


[{"label":"Latest (v1.1)","version":"latest"}]
vmc
Feedback

Was this page helpful?