Get Clusters
DescriptionRetrieves the primary cluster in provided customer sddc UUID
Request
URLURL
Path Parameters
Path Parameters
Organization identifier
Sddc identifier
Authentication
Response
Response BodyResponse Body
200 OK
{
"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"
}
}
AWS Key Management Service information associated with this cluster
Possible values are: DEPLOYING , ADDING_HOSTS , READY , FAILED
Number of cores enabled on ESX hosts added to this cluster
Specifies whether hyperThreading is disabled/enabled explicitly
The Microsoft license configuration of this cluster.
Partition placement group infos
Errors
The sddc is not in a state that’s valid for fetching the primary cluster.
Unauthorized
Access not allowed to the operation for the current user
Cannot find the sddc with the given identifier to fetch the primary cluster
Code Samples
PowerCLI Client SDK Example
cURL Command
Vendor Extensions
x-vmc-ui-servicename: clusters
x-vmw-vapi-methodname: get