Get Federation Details
Get details of a federation
Request
URI
GET
https://{api_host}/v1/sddc-federation
COPY
Responses
200
OK
Returns
Array of
MemberInfo
of type(s)
application/json
[
{
"memberDetails": {
"city": "string",
"coordinate": {
"latitude": "number",
"longitude": "number"
},
"country": "string",
"fqdn": "string",
"role": "string",
"siteName": "string",
"siteType": "string",
"state": "string"
},
"memberHealth": {
"healthCode": "string",
"healthDetails": [
"string"
]
},
"memberInventory": {
"capacity": {
"summary": {
"aggregatedCapacity": {
"cpu": {
"free": "number",
"total": "number",
"unallocated": "number",
"unit": "string",
"used": "number"
},
"datastores": [
{
"capacity": "number",
"datastoreName": "string",
"datastoreType": "string",
"freeSpace": "number",
"unallocated": "number",
"unit": "string",
"used": "number"
}
],
"hostCount": {
"total": 0,
"unallocated": 0,
"used": 0
},
"memory": {
"totalCapacityMB": "number",
"usedCapacityMB": "number"
}
},
"domainCount": 0,
"domainInfo": [
{
"domainCapacity": {
"cpu": {
"free": "number",
"total": "number",
"unallocated": "number",
"unit": "string",
"used": "number"
},
"datastores": [
{
"capacity": "number",
"datastoreName": "string",
"datastoreType": "string",
"freeSpace": "number",
"unallocated": "number",
"unit": "string",
"used": "number"
}
],
"hostCount": {
"total": 0,
"unallocated": 0,
"used": 0
},
"memory": {
"totalCapacityMB": "number",
"usedCapacityMB": "number"
}
},
"domainId": "string",
"name": "string",
"status": "string",
"type": "string"
}
],
"domainTypeInfo": [
{
"aggregatedCapacity": {
"cpu": {
"free": "number",
"total": "number",
"unallocated": "number",
"unit": "string",
"used": "number"
},
"datastores": [
{
"capacity": "number",
"datastoreName": "string",
"datastoreType": "string",
"freeSpace": "number",
"unallocated": "number",
"unit": "string",
"used": "number"
}
],
"hostCount": {
"total": 0,
"unallocated": 0,
"used": 0
},
"memory": {
"totalCapacityMB": "number",
"usedCapacityMB": "number"
}
},
"domainCount": 0,
"type": "string"
}
]
}
},
"createTime": "string",
"creationTime": "string",
"inventoryInfo": {
"hostCount": {
"total": 0,
"unallocated": 0,
"used": 0
}
},
"softwareInfo": {
"pendingUpdates": 0
}
},
"memberLiveness": {
"livelinessCode": "string",
"livelinessDetails": [
"string"
]
}
}
]Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/v1/sddc-federation