Developer Documentation
Get Primary Cluster
Retrieves the primary cluster in provided customer sddc UUID
Request
URLURL
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/primarycluster
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Organization identifier |
| required |
|
string | Sddc identifier |
Response
Response
Response BodyResponse Body
200 OK returns
Cluster
{
"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": "string",
"esx_host_info": {
"instance_type": "string"
},
"esx_host_list": [
{
"availability_zone": "string",
"custom_properties": {
"key": "string"
},
"esx_id": "string",
"esx_state": "string",
"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",
"provider": "string"
}
],
"host_cpu_cores_count": 0,
"msft_license_config": {
"mssql_licensing": "string",
"windows_licensing": "string"
}
}| Property Name | Type | Description |
|---|---|---|
| cluster_id | string | Not available |
| aws_kms_info | AwsKmsInfo |
AWS Key Management Service information associated with this cluster |
| cluster_capacity | EntityCapacity |
The capacity of this cluster. |
| cluster_name | string | Not available |
| cluster_state | string |
Not available
Possible values are: ADDING_HOSTS, DEPLOYING, FAILED, READY |
| esx_host_info | EsxHostInfo |
Information of the hosts added to this cluster |
| esx_host_list | array of AwsEsxHost | Not available |
| host_cpu_cores_count | integer |
Number of cores enabled on ESX hosts added to this cluster |
| msft_license_config | MsftLicensingConfig |
The Microsoft license configuration of this cluster. |
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | ErrorResponse | The request cannot be fulfilled due to bad syntax. |
| 401 | Nothing | The request requires user authentication. |
| 403 | ErrorResponse | The server understood the request, but is refusing to fulfill it. |
| 404 | ErrorResponse | The requested resource could not be found but may be available again in the future. |
