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

vmc

Get Clusters

Description

Retrieves the primary cluster in provided customer sddc UUID

Request

URL

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.

api_key

Response

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": [
		{
			"availability_zone": "string",
			"custom_properties": {
				"key": "string"
			},
			"eni_list": [
				{
					"association_id": "string",
					"attachment_id": "string",
					"id": "string",
					"instance_id": "string",
					"mac_address": "string",
					"portgroup": "string",
					"private_ip": "string",
					"public_ips": [
						"string"
					],
					"secondary_ips": [
						"string"
					],
					"security_group_id": "string",
					"source_dest_check_false": false,
					"subnet_id": "string",
					"vmk_id": "string"
				}
			],
			"esx_id": "string",
			"esx_state": "DEPLOYING",
			"hostname": "string",
			"instance_type": "string",
			"internal_public_ip_pool": [
				{
					"allocation_id": "string",
					"associated_private_ip": "string",
					"dnat_rule_id": "string",
					"name": "string",
					"public_ip": "string",
					"snat_rule_id": "string"
				}
			],
			"mac_address": "string",
			"name": "string",
			"partition_number": 0,
			"provider": "string",
			"xeni_info": {
				"association_id": "string",
				"trunk_eni_id": "string",
				"x_eni_id": "string"
			}
		}
	],
	"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": {
		"eni_info": {
			"association_id": "string",
			"attachment_id": "string",
			"id": "string",
			"instance_id": "string",
			"mac_address": "string",
			"portgroup": "string",
			"private_ip": "string",
			"public_ips": [
				"string"
			],
			"secondary_ips": [
				"string"
			],
			"security_group_id": "string",
			"source_dest_check_false": false,
			"subnet_id": "string",
			"vmk_id": "string"
		},
		"enum_state": "DEPLOYING",
		"esx_id": "string",
		"hostname": "string",
		"instance_id": "string",
		"mac_address": "string",
		"name": "string",
		"provider": "string"
	},
	"wcp_details": {
		"egress_cidr": "string",
		"ingress_cidr": "string",
		"pod_cidr": "string",
		"service_cidr": "string",
		"wcp_status": "CERTIFICATE_REVOKE_FAILED"
	}
}

string

cluster_id Required

AwsKmsInfo

aws_kms_info Optional

AWS Key Management Service information associated with this cluster

EntityCapacity

cluster_capacity Optional

The capacity of this cluster.

string

cluster_name Optional

string

cluster_state Optional

Possible values are: DEPLOYING , ADDING_HOSTS , READY , FAILED

map of string

custom_properties Optional

EsxHostInfo

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

MsftLicensingConfig

msft_license_config Optional

The Microsoft license configuration of this cluster.

array of PartitionPlacementGroupInfo

partition_placement_group_info Optional

Partition placement group infos

AwsWitnessEsx

vsan_witness Optional

Witness node

WcpDetails

wcp_details Optional

WCP details for a given cluster

Errors

ErrorResponse

400

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

401

Unauthorized

ErrorResponse

403

Access not allowed to the operation for the current user

ErrorResponse

404

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

Code Samples

PowerCLI Client SDK Example

Invoke-OrgsOrgSddcsSddcPrimaryclusterGet -Org "MyOrg" -Sddc "MySddc"

cURL Command

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

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vmc-ui-servicename: clusters
x-vmw-vapi-methodname: get

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

vmc

SDDC Operations

post

Create Clusters

post

Create SDDCs

post

Create SDDCs

delete

Delete Clusters

delete

Delete SDDCs

get

Get Clusters

get

Get Provision Spec

get

Get SDDCs

get

List SDDCs

patch

Patch SDDCs

Get Clusters

Request

URL

Path Parameters

Authentication

api_key

Response

Response Body

200 OK

Errors

Code Samples

PowerCLI Client SDK Example

cURL Command

Vendor Extensions

On This Page

SDDC Operations

Was this page helpful?