Get Cluster Configure | VMware Cloud on AWS API Reference

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

URI

GET

https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/clusters/{cluster}/config/constraints

COPY

Path Parameters

string

org

Required

Organization identifier

string

sddc

Required

Sddc identifier

string

cluster

Required

cluster identifier

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.

api_key

Responses

200

Returns VsanClusterReconfigConstraints of type(s) application/json

{
    "reconfig_biases": [
        {
            "short_description": "string",
            "full_description": "string",
            "id": "string"
        }
    ],
    "hosts": 0,
    "default_reconfig_bias_id": "string"
}

array of VsanClusterReconfigBias

reconfig_biases

Required

Biases to reconfigure vSAN in an existing cluster.

object

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.

object

default_capacities

Required

A map of VsanClusterReconfigBias id to a VsanAvailableCapacity. It gives the default VsanAvailableCapacity for each of reconfiguration biases.

integer As int32 As int32

hosts

Required

The number of hosts in a cluster for the constraints.

string

default_reconfig_bias_id

Required

The id of default VsanClusterReconfigBias for this constraints.