Get Domain
Get a domain by its ID
Domain ID
Ok
{
"id": "string",
"name": "string",
"orgName": "string",
"status": "One among: ACTIVE, ACTIVATING, UPGRADING, DISABLED, ERROR, SKIPPED, DEACTIVATING, EXPANDING, SHRINKING, CREATING",
"upgradeState": "One among: AVAILABLE, FAILED",
"upgradeStatus": {
"status": "One among: UP_TO_DATE, SCHEDULED, IN_PROGRESS, READY, AVAILABLE",
"completedResources": 0,
"totalResources": 0
},
"type": "string",
"vraIntegrationStatus": "One among: ENABLED, DISABLED, FAILED, IN_PROGRESS",
"vropsIntegrationStatus": "One among: ENABLED, DISABLED, FAILED, IN_PROGRESS",
"vrliIntegrationStatus": "One among: ENABLED, DISABLED, FAILED, IN_PROGRESS",
"owners": [
"string"
],
"vcenters": [
{
"id": "string",
"fqdn": "string",
"vcInstanceId": "string"
}
],
"ssoId": "string",
"ssoName": "string",
"isManagementSsoDomain": false,
"clusters": [
{
"id": "string",
"name": "string"
}
],
"nsxtCluster": {
"id": "string",
"vipFqdn": "string",
"vip": "string"
},
"licensingInfo": {
"licensingMode": "One among: SUBSCRIPTION, PERPETUAL, MIXED",
"subscriptionStatus": "One among: UNSUBSCRIBED, ACTIVE, EXPIRED",
"isRegistered": false,
"isSubscribed": false,
"daysRemainingToSubscribe": 0
},
"capacity": {
"cpu": {
"used": {
"value": "number",
"unit": "string"
},
"total": {
"value": "number",
"unit": "string"
},
"numberOfCores": 0,
"numberOfCPUPackages": 0
},
"memory": {
"used": {
"value": "number",
"unit": "string"
},
"total": {
"value": "number",
"unit": "string"
}
},
"storage": {
"used": {
"value": "number",
"unit": "string"
},
"total": {
"value": "number",
"unit": "string"
}
}
},
"tags": [
{
"id": "string",
"name": "string",
"categoryId": "string",
"categoryName": "string"
}
],
"elmStatus": "One among: ISOLATED, IN_TRANSIT, LINKED",
"lifecycleManagementMode": "One among: IMAGES, BASELINES, BASELINES_AND_IMAGES",
"isNetworkSeparationEnabled": false,
"isSecurityEnabled": false,
"isPrimaryDomainForNsx": false
}ID of the workload domain
Name of the workload domain
Organization name of the workload domain
Status of the workload domain
Workload domain upgrade state
Represents upgrade status of a domain
Type of the workload domain
Status that represents the workload domain integration with VMware Aria Automation
Status that represents the workload domain integration with VMware Aria Operations
Status that represents the workload domain integration with VMware Aria Operations for Logs
List of users owning the workload domain
List of vCenters associated with the workload domain
ID of the SSO domain associated with the workload domain
Name of the SSO domain associated with the workload domain
Shows whether the workload domain is joined to the Management domain SSO
List of clusters associated with the workload domain
Represents an NSX Cluster reference
Represents a Licensing information
Represents a usage and capacity information of a Resource
Deprecated, this list will always be returned empty
ELM status of the domain: ISOLATED, IN_TRANSIT, or LINKED
Lifecycle Management mode of the domain
Domain network separation status
Domain security status
Is Primary Domain of NSX
Domain not found
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
InternalServerError
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
curl -H 'Authorization: <value>' https://{api_host}/v1/domains/{id}