Get Cluster Configure
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
URLURL
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/clusters/{cluster}/config/constraints
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
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VsanClusterReconfigConstraints of type(s) application/json
{
"available_capacities": {
"key": {
"cost": "string",
"quality": "string",
"size": 0
}
},
"default_capacities": {
"key": {
"cost": "string",
"quality": "string",
"size": 0
}
},
"default_reconfig_bias_id": "string",
"hosts": 0,
"reconfig_biases": [
{
"full_description": "string",
"id": "string",
"short_description": "string"
}
]
}
map of
VsanAvailableCapacity
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.
map of
VsanAvailableCapacity
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
hosts
Required
The number of hosts in a cluster for the constraints.
array of
VsanClusterReconfigBias
reconfig_biases
Required
Biases to reconfigure vSAN in an existing cluster.
cURL Command
curl https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/clusters/{cluster}/config/constraints
Errors
400
Invalid or missing parameters
401
Unauthorized
403
Forbidden
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmc-ui-servicename: clusterConfigure
x-vmw-vapi-methodname: get
