Get Clusters

Get Clusters

Retrieves the primary cluster in provided customer sddc UUID

Request
URI
GET
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/primarycluster
COPY
Path Parameters
string
org
Required

Organization identifier

string
sddc
Required

Sddc identifier


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Cluster of type(s) application/json
{
    "cluster_capacity": {
        "storage_capacity_gib": 0,
        "memory_capacity_gib": 0,
        "total_number_of_cores": 0,
        "number_of_ssds": 0,
        "cpu_capacity_ghz": "number",
        "number_of_sockets": 0
    },
    "esx_host_list": [
        {
            "availability_zone": "string",
            "esx_id": "string",
            "durable_host_name": "string",
            "state_last_updated": "string",
            "name": "string",
            "custom_properties": {
                "custom_properties": "string"
            },
            "hostname": "string",
            "provider": "string",
            "instance_type": "string",
            "mac_address": "string",
            "esx_state": "string",
            "capacity_pool": "string",
            "eni_list": [
                {
                    "secondary_ips": [
                        "string"
                    ],
                    "attachment_id": "string",
                    "association_id": "string",
                    "vmk_id": "string",
                    "device_index": 0,
                    "security_group_id": "string",
                    "instance_id": "string",
                    "subnet_id": "string",
                    "public_ips": [
                        "string"
                    ],
                    "private_ip": "string",
                    "mac_address": "string",
                    "source_dest_check_false": false,
                    "portgroup": "string",
                    "id": "string"
                }
            ],
            "xeni_info": {
                "association_id": "string",
                "trunk_eni_id": "string",
                "x_eni_id": "string"
            },
            "partition_number": 0,
            "ec2_instance_running_status_count": 0,
            "esx_nic_info": {
                "ip": "string",
                "mac": "string",
                "vlan": "string",
                "gateway": "string",
                "net-stack": "string"
            },
            "internal_public_ip_pool": [
                {
                    "public_ip": "string",
                    "name": "string",
                    "allocation_id": "string",
                    "dnat_rule_id": "string",
                    "associated_private_ip": "string",
                    "snat_rule_id": "string"
                }
            ]
        }
    ],
    "wcp_details": {
        "pod_cidr": "string",
        "egress_cidr": "string",
        "ingress_cidr": "string",
        "service_cidr": "string",
        "wcp_status": "string"
    },
    "msft_license_config": {
        "mssql_licensing": "string",
        "academic_license": false,
        "windows_licensing": "string"
    },
    "cluster_state": "string",
    "esx_host_info": {
        "instance_type": "string"
    },
    "host_cpu_cores_count": 0,
    "partition_placement_group_info": [
        {
            "partition_group_names": [
                "string"
            ],
            "availability_zone": "string"
        }
    ],
    "cluster_id": "string",
    "availability_type": "string",
    "mgmt_rp_name": "string",
    "aws_kms_info": {
        "amazon_resource_name": "string"
    },
    "availability_zones": [
        "string"
    ],
    "compute_rp_name": "string",
    "vsan_witness": {
        "instance_id": "string",
        "eni_info": {
            "secondary_ips": [
                "string"
            ],
            "attachment_id": "string",
            "association_id": "string",
            "vmk_id": "string",
            "device_index": 0,
            "security_group_id": "string",
            "instance_id": "string",
            "subnet_id": "string",
            "public_ips": [
                "string"
            ],
            "private_ip": "string",
            "mac_address": "string",
            "source_dest_check_false": false,
            "portgroup": "string",
            "id": "string"
        }
    },
    "custom_properties": {
        "custom_properties": "string"
    },
    "cluster_name": "string",
    "vsan_version": "string",
    "hyper_threading_enabled": false
}
object
cluster_capacity
Optional

Decribes the capacity of an entity in a provisioned cluster or to be used in an already-provisioned cluster.

array of object
esx_host_list
Optional

esx_host_list

object
wcp_details
Optional

wcp_details

object
msft_license_config
Optional

msft_license_config

string
cluster_state
Optional

cluster_state

Possible values are : DEPLOYING, ADDING_HOSTS, READY, FAILED,
object
esx_host_info
Optional

esx_host_info

integer As int32 As int32
host_cpu_cores_count
Optional

Number of cores enabled on ESX hosts added to this cluster

array of object
partition_placement_group_info
Optional

Partition placement group infos

string
cluster_id
Required

cluster_id

string
availability_type
Optional

Identifies either cluster is a SingleAZ or a MultiAZ.

Possible values are : SINGLE_AZ, MULTI_AZ,
string
mgmt_rp_name
Optional

mgmt_rp_name

object
aws_kms_info
Optional

aws_kms_info

array of string
availability_zones
Optional

Name of the availability zone.

string
compute_rp_name
Optional

compute_rp_name

object
vsan_witness
Optional

vsan_witness

object
custom_properties
Optional

custom_properties

string
cluster_name
Optional

cluster_name

string
vsan_version
Optional

Version of vSAN used in this cluster. Empty means vsan 1.0

boolean
hyper_threading_enabled
Optional

Specifies whether hyperThreading is disabled/enabled explicitly


400

The sddc is not in a state that's valid for fetching the primary cluster.

Returns ErrorResponse of type(s) application/json
"ErrorResponse Object"
integer
status
Required

HTTP status code

string
path
Required

Originating request URI

boolean
retryable
Required

If true, client should retry operation

string
error_code
Required

unique error code

array of string
error_messages
Required

localized error messages


401

Unauthorized

Operation doesn't return any data structure

403

Access not allowed to the operation for the current user

Returns ErrorResponse of type(s) application/json
"ErrorResponse Object"
integer
status
Required

HTTP status code

string
path
Required

Originating request URI

boolean
retryable
Required

If true, client should retry operation

string
error_code
Required

unique error code

array of string
error_messages
Required

localized error messages


404

Cannot find the sddc with the given identifier to fetch the primary cluster

Returns ErrorResponse of type(s) application/json
"ErrorResponse Object"
integer
status
Required

HTTP status code

string
path
Required

Originating request URI

boolean
retryable
Required

If true, client should retry operation

string
error_code
Required

unique error code

array of string
error_messages
Required

localized error messages


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/vmc/api/orgs/{org}/sddcs/{sddc}/primarycluster