Get Cluster Storage Constraints
Get constraints on cluster storage size for EBS-backed clusters.
Request
URLURL
https://vmc.vmware.com/vmc/api/orgs/{org}/storage/cluster-constraints
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Organization identifier |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
integer | Number of hosts in cluster |
| required |
|
string | Cloud storage provider ID (example AWS) |
Response
Response
Response BodyResponse Body
200 OK returns
VsanConfigConstraints
{
"max_capacity": 0,
"min_capacity": 0,
"num_hosts": 0,
"recommended_capacities": [
0
],
"supported_capacity_increment": 0
}| Property Name | Type | Description |
|---|---|---|
| max_capacity | integer |
Maximum capacity supported for cluster (GiB). |
| min_capacity | integer |
Minimum capacity supported for cluster (GiB). |
| num_hosts | integer |
Number of hosts in cluster. |
| recommended_capacities | array of integer |
List of supported capacities which may offer preferable performance (GiB). |
| supported_capacity_increment | integer |
Increment to be added to min_capacity to result in a supported capacity (GiB). |
cURL Command
curl https://vmc.vmware.com/vmc/api/orgs/{org}/storage/cluster-constraints?num_hosts=string&provider=string
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | Nothing | The request cannot be fulfilled due to bad syntax. |
| 401 | Nothing | The request requires user authentication. |
| 403 | Nothing | The server understood the request, but is refusing to fulfill it. |
