[{"label":"Latest (v1.1)","version":"latest"}]
vmc

Get Clusters

Description

Retrieves the primary cluster in provided customer sddc UUID

Request

Request

URL

URL


get
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/primarycluster
Copy

Path Parameters

Path Parameters

string
org Required

Organization identifier


string
sddc Required

Sddc identifier


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns Cluster of type(s) application/json
{
	"aws_kms_info": {
		"amazon_resource_name": "string"
	},
	"cluster_capacity": {
		"cpu_capacity_ghz": 0,
		"memory_capacity_gib": 0,
		"number_of_sockets": 0,
		"number_of_ssds": 0,
		"storage_capacity_gib": 0,
		"total_number_of_cores": 0
	},
	"cluster_id": "string",
	"cluster_name": "string",
	"cluster_state": "DEPLOYING",
	"custom_properties": {
		"key": "string"
	},
	"esx_host_info": {
		"instance_type": "string"
	},
	"esx_host_list": [
		{}
	],
	"host_cpu_cores_count": 0,
	"hyper_threading_enabled": false,
	"msft_license_config": {
		"academic_license": false,
		"mssql_licensing": "DISABLED",
		"windows_licensing": "DISABLED"
	},
	"partition_placement_group_info": [
		{
			"availability_zone": "string",
			"partition_group_names": [
				"string"
			]
		}
	],
	"vsan_witness": {},
	"wcp_details": {
		"egress_cidr": "string",
		"ingress_cidr": "string",
		"pod_cidr": "string",
		"service_cidr": "string",
		"wcp_status": "CERTIFICATE_REVOKE_FAILED"
	}
}
string
cluster_id Required

aws_kms_info Optional

AWS Key Management Service information associated with this cluster


cluster_capacity Optional

The capacity of this cluster.


string
cluster_name Optional

string
cluster_state Optional

Possible values are: DEPLOYINGADDING_HOSTSREADYFAILED


map of string
custom_properties Optional

esx_host_info Optional

Information of the hosts added to this cluster


array of AwsEsxHost
esx_host_list Optional

integer as int32
host_cpu_cores_count Optional

Number of cores enabled on ESX hosts added to this cluster


boolean
hyper_threading_enabled Optional

Specifies whether hyperThreading is disabled/enabled explicitly


msft_license_config Optional

The Microsoft license configuration of this cluster.


partition_placement_group_info Optional

Partition placement group infos


vsan_witness Optional

Witness node


wcp_details Optional

WCP details for a given cluster

Errors

Errors

400

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


401

Unauthorized


403

Access not allowed to the operation for the current user


404

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

Code Samples

Code Samples

cURL Command

curl https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/primarycluster
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmc-ui-servicename: clusters
x-vmw-vapi-methodname: get


Feedback

Was this page helpful?