Get Domain

Get a domain by its ID

Request

URI

GET

https://{api_host}/v1/domains/{id}

COPY

Path Parameters

string

Required

Domain ID

Responses

200

Returns Domain of type(s) application/json

{
    "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
}

string

Optional

ID of the workload domain

string

name

Optional

Name of the workload domain

string

orgName

Optional

Organization name of the workload domain

string

status

Optional

Status of the workload domain

string

upgradeState

Optional

Workload domain upgrade state

UpgradeStatus

upgradeStatus

Optional

Represents upgrade status of a domain

string

type

Optional

Type of the workload domain

string

vraIntegrationStatus

Optional

Status that represents the workload domain integration with VMware Aria Automation

string

vropsIntegrationStatus

Optional

Status that represents the workload domain integration with VMware Aria Operations

string

vrliIntegrationStatus

Optional

Status that represents the workload domain integration with VMware Aria Operations for Logs

array of string

owners

Optional

List of users owning the workload domain

array of VcenterReference

vcenters

Optional

List of vCenters associated with 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

boolean

isManagementSsoDomain

Optional

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

array of ClusterReference

clusters

Optional

List of clusters associated with the workload domain

NsxTClusterReference

nsxtCluster

Optional

Represents an NSX Cluster reference

LicensingInfoReference

licensingInfo

Optional

Represents a Licensing information

Capacity

capacity

Optional

Represents a usage and capacity information of a Resource

array of Tag

tags

Optional

Deprecated, this list will always be returned empty

string

elmStatus

Optional

ELM status of the domain: ISOLATED, IN_TRANSIT, or LINKED

string

lifecycleManagementMode

Optional

Lifecycle Management mode of the domain

boolean

isNetworkSeparationEnabled

Optional

Domain network separation status

boolean

isSecurityEnabled

Optional

Domain security status

boolean

isPrimaryDomainForNsx

Optional

Is Primary Domain of NSX

404

Domain not found

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object

context

Optional

The error context (e.g. the component where it occurred).

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of ErrorCause

causes

Optional

The underlying cause exceptions.

array of Error

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

500

InternalServerError

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.