[{"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 Domain

Description

Get a Domain

Request

URL

get

https://sfo-vcf01.rainpole.io/v1/domains/{id}

Copy

Path Parameters

string

id Required

Domain ID

Response

Response Body

200 OK

Returns Domain of type(s) application/json

{
	"capacity": {
		"cpu": {
			"total": {
				"unit": "Hz",
				"value": 0
			},
			"used": {
				"unit": "Hz",
				"value": 0
			}
		},
		"memory": {
			"total": {
				"unit": "B",
				"value": 0
			},
			"used": {
				"unit": "B",
				"value": 0
			}
		},
		"storage": {
			"total": {
				"unit": "B",
				"value": 0
			},
			"used": {
				"unit": "B",
				"value": 0
			}
		}
	},
	"clusters": [
		{
			"id": "string"
		}
	],
	"id": "string",
	"isManagementSsoDomain": false,
	"name": "string",
	"nsxtCluster": {
		"id": "string",
		"vip": "string",
		"vipFqdn": "string"
	},
	"ssoId": "string",
	"ssoName": "string",
	"status": "string",
	"tags": [
		{
			"categoryId": "string",
			"categoryName": "string",
			"id": "string",
			"name": "string"
		}
	],
	"type": "string",
	"vcenters": [
		{
			"fqdn": "string",
			"id": "string"
		}
	]
}

Capacity

capacity Optional

Capacity information for the workload domain

array of ClusterReference

clusters Optional

List of clusters associated with the workload domain

string

id Optional

ID of the workload domain

boolean

isManagementSsoDomain Introduced Optional

Shows whether the workload domain is joined to the Management domain SSO

string

name Optional

Name of the workload domain

NsxTClusterReference

nsxtCluster Optional

NSX-T cluster associated with the workload domain

string

ssoId Introduced Optional

ID of the SSO domain associated with the workload domain

string

ssoName Introduced Optional

Name of the SSO domain associated with the workload domain

string

status Optional

Status of the workload domain

array of Tag

tags Optional

Deprecated, this list will always be returned empty

string

type Optional

Type of the workload domain

array of VcenterReference

vcenters Optional

List of vCenters associated with the workload domain

Errors

Error

404

Domain not found

Error

500

InternalServerError

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/domains/{id}

vcf-for-vxrail

Domains Operations

put

Assign Tags To Existing Domain Introduced

get

Assignable Tags To Domain Introduced

post

Create Domain

delete

Delete Domain

get

Domain Create Validation

get

Get Cluster Criteria

get

Get Cluster Criterion

get

Get Cluster Query Response

get

Get Clusters Query Response

get

Get Datastore Criterion Introduced

get

Get Datastore Query Response Introduced

get

Get Datastores Criteria Introduced

get

Get Domain

get

Get Domain Endpoints

get

Get Domain Tag Manager URL

get

Get Domain Update Validation

get

Get Domains

get

Get Tags Assigned To Domain

get

Get Tags Assigned To Domains Introduced

post

Post Cluster Query

post

Post Clusters Query

post

Post Datastore Query Introduced

delete

Remove Tags From Domain Introduced

patch

Update Domain Changed

post

Validate Domains Operations

post

Validate Domains Operations

Get Domain

Request

URL

Path Parameters

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Domains Operations

Was this page helpful?