[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

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",
	"name": "string",
	"nsxtCluster": {
		"id": "string",
		"vip": "string",
		"vipFqdn": "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

string

name Optional

Name of the workload domain

NsxTClusterReference

nsxtCluster Optional

NSX-T cluster associated with the workload domain

string

status Optional

Status of the workload domain

array of Tag

tags Introduced Optional

List of assigned tags for the domain

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

Domains Operations

post

Assign Tags To Domain Introduced

get

Attachable Tags To Domain Introduced

post

Create Domain

delete

Delete Domain

post

Detach Tags From Domain Introduced

get

Get Cluster Criteria

get

Get Cluster Criterion

get

Get Cluster Query Response

get

Get Clusters Query Response

get

Get Domain

get

Get Domain Endpoints

get

Get Domain Tag Manager URL Introduced

get

Get Domains

get

Get Tags Assigned To Domain Introduced

post

Post Cluster Query

post

Post Clusters Query

patch

Update Domain

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?