[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail

Get Federation Details

Description

Get details of a federation

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/sddc-federation
Copy

Response

Response

Response Body

Response Body

200 OK

Returns array of MemberInfo of type(s) application/json
{
	"memberDetails": {
		"city": "string",
		"coordinate": {
			"latitude": 0,
			"longitude": 0
		},
		"country": "string",
		"fqdn": "string",
		"role": "CONTROLLER",
		"siteName": "string",
		"siteType": "DATACENTER",
		"state": "string"
	},
	"memberHealth": {
		"healthCode": "GREEN",
		"healthDetails": [
			"string"
		]
	},
	"memberInventory": {
		"capacity": {
			"summary": {
				"aggregatedCapacity": {
					"cpu": {
						"free": 0,
						"total": 0,
						"unallocated": 0,
						"unit": "GHZ",
						"used": 0
					},
					"datastores": [
						{
							"datastoreType": "string",
							"freeCapacityGB": 0,
							"id": "string",
							"name": "string",
							"tags": [
								{
									"categoryId": "string",
									"categoryName": "string",
									"id": "string",
									"name": "string"
								}
							],
							"totalCapacityGB": 0,
							"url": "string",
							"vcDatacenterName": "string",
							"vcInstanceUuid": "string",
							"vmCount": 0
						}
					],
					"hostCount": {
						"total": 0,
						"unallocated": 0,
						"used": 0
					},
					"memory": {
						"totalCapacityMB": 0,
						"usedCapacityMB": 0
					}
				},
				"domainCount": 0,
				"domainInfo": [
					{
						"domainCapacity": {
							"cpu": {
								"free": 0,
								"total": 0,
								"unallocated": 0,
								"unit": "GHZ",
								"used": 0
							},
							"datastores": [
								{
									"datastoreType": "string",
									"freeCapacityGB": 0,
									"id": "string",
									"name": "string",
									"tags": [
										{
											"categoryId": "string",
											"categoryName": "string",
											"id": "string",
											"name": "string"
										}
									],
									"totalCapacityGB": 0,
									"url": "string",
									"vcDatacenterName": "string",
									"vcInstanceUuid": "string",
									"vmCount": 0
								}
							],
							"hostCount": {
								"total": 0,
								"unallocated": 0,
								"used": 0
							},
							"memory": {
								"totalCapacityMB": 0,
								"usedCapacityMB": 0
							}
						},
						"domainId": "string",
						"name": "string",
						"status": "string",
						"type": "string"
					}
				],
				"domainTypeInfo": [
					{
						"aggregatedCapacity": {
							"cpu": {
								"free": 0,
								"total": 0,
								"unallocated": 0,
								"unit": "GHZ",
								"used": 0
							},
							"datastores": [
								{
									"datastoreType": "string",
									"freeCapacityGB": 0,
									"id": "string",
									"name": "string",
									"tags": [
										{
											"categoryId": "string",
											"categoryName": "string",
											"id": "string",
											"name": "string"
										}
									],
									"totalCapacityGB": 0,
									"url": "string",
									"vcDatacenterName": "string",
									"vcInstanceUuid": "string",
									"vmCount": 0
								}
							],
							"hostCount": {
								"total": 0,
								"unallocated": 0,
								"used": 0
							},
							"memory": {
								"totalCapacityMB": 0,
								"usedCapacityMB": 0
							}
						},
						"domainCount": 0,
						"type": "string"
					}
				]
			}
		},
		"createTime": "string",
		"creationTime": "string",
		"inventoryInfo": {
			"hostCount": {
				"total": 0,
				"unallocated": 0,
				"used": 0
			}
		},
		"softwareInfo": {
			"pendingUpdates": 0
		}
	},
	"memberLiveness": {
		"livelinessCode": "GREEN",
		"livelinessDetails": [
			"string"
		]
	}
}
memberDetails Optional

memberHealth Optional

memberInventory Optional

memberLiveness Optional

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/sddc-federation


[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Feedback

Was this page helpful?