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
string
org
Required
Organization identifier
Query Parameters
Query Parameters
integer
num_hosts
Required
Number of hosts in cluster
string
provider
Required
Cloud storage provider ID (example AWS)
Response
Response
Response BodyResponse Body
200 OK returns
VsanConfigConstraints of type(s) application/json
{
"max_capacity": 0,
"min_capacity": 0,
"num_hosts": 0,
"recommended_capacities": [
0
],
"supported_capacity_increment": 0
}
integer
max_capacity
Required
Maximum capacity supported for cluster (GiB).
integer
min_capacity
Required
Minimum capacity supported for cluster (GiB).
integer
num_hosts
Required
Number of hosts in cluster.
array of
integer
recommended_capacities
Required
List of supported capacities which may offer preferable performance (GiB).
integer
supported_capacity_increment
Optional
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
400
Invalid or missing parameters
401
Unauthorized
403
Forbidden
