Get Cluster Configuration Constraints
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
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Organization identifier |
| required |
|
string | Sddc identifier |
| required |
|
string | cluster identifier |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
integer | The expected number of hosts in the cluster. If not specified, returned is based on current number of hosts in the cluster. |
Response
Response
Response BodyResponse Body
200 OK returns
VsanClusterReconfigConstraints
{
"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"
}
]
}| Property Name | Type | Description |
|---|---|---|
| available_capacities | map of VsanAvailableCapacity |
A map of VsanClusterReconfigBias id to the list of VsanAvailableCapacity. It gives all of available vSAN capacities for each of reconfiguration biases. |
| default_capacities | map of VsanAvailableCapacity |
A map of VsanClusterReconfigBias id to a VsanAvailableCapacity. It gives the default VsanAvailableCapacity for each of reconfiguration biases. |
| default_reconfig_bias_id | string |
The id of default VsanClusterReconfigBias for this constraints. |
| hosts | integer |
The number of hosts in a cluster for the constraints. |
| reconfig_biases | array of VsanClusterReconfigBias |
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
| Code | Returns | Description |
|---|---|---|
| 403 | Nothing | The server understood the request, but is refusing to fulfill it. |
| 400 | Nothing | The request cannot be fulfilled due to bad syntax. |
| 401 | Nothing | The request requires user authentication. |
