[{"label":"Latest (v1.1)","version":"latest"}]
vmc
Get Storage
DescriptionGet 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)
Authentication
This operation uses the following authentication methods.
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 as int64
max_capacity
Required
Maximum capacity supported for cluster (GiB).
integer as int64
min_capacity
Required
Minimum capacity supported for cluster (GiB).
integer as int64
num_hosts
Required
Number of hosts in cluster.
array of
integer as int64
recommended_capacities
Required
List of supported capacities which may offer preferable performance (GiB).
integer as int64
supported_capacity_increment
Optional
Increment to be added to min_capacity to result in a supported capacity (GiB).
Errors
400
Invalid or missing parameters
401
Unauthorized
403
Forbidden
Code Samples
PowerCLI Client SDK Example
Invoke-OrgsOrgStorageClusterConstraintsGet -Org "MyOrg" -Provider "MyProvider" -NumHosts 56
cURL Command
curl https://vmc.vmware.com/vmc/api/orgs/{org}/storage/cluster-constraints?num_hosts=10&provider=string
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmc-ui-servicename: storage
x-vmw-vapi-methodname: get
[{"label":"Latest (v1.1)","version":"latest"}]
vmc
On This Page
Storage Operations
get
