[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"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
DescriptionGet a Domain
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/domains/{id}
Path Parameters
Path Parameters
string
id
Required
Domain ID
Response
Response
Response BodyResponse 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"
}
]
}
string
id
Optional
ID of the workload domain
boolean
isManagementSsoDomain
Optional
Shows whether the workload domain is joined to the Management domain SSO
string
name
Optional
Name of the workload domain
string
ssoId
Optional
ID of the SSO domain associated with the workload domain
string
ssoName
Optional
Name of the SSO domain associated with the workload domain
string
status
Optional
Status of the workload domain
string
type
Optional
Type of 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}
[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"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
On This Page
Domains Operations
post
delete
get
get
post
post
post
delete
patch
