[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Get SDDC

Description

Retrieve a specific Software-Defined Datacenter.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/sddcs/{id}
Copy

Path Parameters

Path Parameters

string
id Required

SDDC ID URN


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns Sddc of type(s) application/json;version=36.3
{
	"defaultEndpoint": {
		"endpoint": "string",
		"id": "string",
		"isDefault": false,
		"name": "SDDC Endpoint Sample Name",
		"proxy": {
			"id": "string",
			"name": "string"
		},
		"proxyId": "string",
		"sddc": {
			"id": "string",
			"name": "string"
		},
		"targetUrl": "https://sampleVc.vmware.com/ui"
	},
	"defaultProxy": {
		"active": false,
		"defaultProxy": false,
		"enabled": false,
		"id": "string",
		"name": "SDDC Proxy Sample Name",
		"parentProxyId": "urn:vcloud:sddcProxy:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
		"sddcId": "urn:vcloud:sddc:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
		"targetHost": "sampleVc.vmware.com",
		"tenantVisible": false,
		"token": "string",
		"uiUrl": "https://sampleVc.vmware.com"
	},
	"description": "SDDC Sample Description",
	"enabled": false,
	"id": "string",
	"name": "SDDC Sample Name",
	"overallStatus": "GRAY",
	"stats": {
		"cpu": {
			"numReserved": 0,
			"numTotal": 0,
			"numUsed": 0
		},
		"memory": {
			"numReserved": 0,
			"numTotal": 0,
			"numUsed": 0
		},
		"poweredOnVMs": 0,
		"storage": {
			"numReserved": 0,
			"numTotal": 0,
			"numUsed": 0
		},
		"totalVMs": 0
	},
	"vcId": "urn:vcloud:vimserver:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
	"version": "6.7.0"
}
string
vcId Required

URN of the associated vCenter. This is not editable once the SDDC has been created.


string
name Required

defaultEndpoint Optional

Default endpoint for the SDDC. There is an endpoint available for an SDDC even if there are no proxies configured for the SDDC. This indicates that an endpoint is available that doesn’t require proxying, either because it is publicly accessible or because it assumes an established VPM connection. The field is read-only.


defaultProxy Optional

Default proxy for the SDDC. This field is read-only. To set a new default, edit the proxy you wish to make the new default by modifying its defaultProxy flag. Deprecated in Api 34.0.


boolean
enabled Optional

string
id Optional

overallStatus Optional

Overall status of the entity

Possible values are: GRAYREDYELLOWGREEN


stats Optional

Associated read-only statistics.


string
description Optional

string
version Optional

Version of the associated vCenter. This is not editable.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/sddcs/{id}


[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?