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
Responses
200
OK
Returns Cluster of type(s) application/json
{
"esx_host_list": [
{
"name": "string",
"availability_zone": "string",
"esx_id": "string",
"hostname": "string",
"provider": "string",
"instance_type": "string",
"mac_address": "string",
"esx_state": "string",
"eni_list": [
{
"secondary_ips": [
"string"
],
"attachment_id": "string",
"association_id": "string",
"vmk_id": "string",
"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"
}
],
"internal_public_ip_pool": [
{
"public_ip": "string",
"name": "string",
"allocation_id": "string",
"dnat_rule_id": "string",
"associated_private_ip": "string",
"snat_rule_id": "string"
}
],
"xeni_info": {
"association_id": "string",
"trunk_eni_id": "string",
"x_eni_id": "string"
},
"partition_number": 0
}
],
"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",
"cluster_name": "string",
"vsan_witness": {
"instance_id": "string",
"eni_info": {
"secondary_ips": [
"string"
],
"attachment_id": "string",
"association_id": "string",
"vmk_id": "string",
"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"
}
},
"aws_kms_info": {
"amazon_resource_name": "string"
},
"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
},
"hyper_threading_enabled": false
}string
cluster_state
Optional
cluster_state
Possible values are : DEPLOYING, ADDING_HOSTS, READY, FAILED,
integer As int32 As int32
host_cpu_cores_count
Optional
Number of cores enabled on ESX hosts added to this cluster
array of PartitionPlacementGroupInfo
partition_placement_group_info
Optional
Partition placement group infos
string
cluster_id
Required
cluster_id
string
cluster_name
Optional
cluster_name
object
custom_properties
Optional
custom_properties
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
{
"status": 0,
"path": "string",
"retryable": false,
"error_code": "string",
"error_messages": [
"string"
]
}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
{
"status": 0,
"path": "string",
"retryable": false,
"error_code": "string",
"error_messages": [
"string"
]
}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
{
"status": 0,
"path": "string",
"retryable": false,
"error_code": "string",
"error_messages": [
"string"
]
}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