Get Domain

Get Domain

Get a domain by its ID

Request
URI
GET
https://sfo-vcf01.rainpole.io//v1/domains/{id}
COPY
Path Parameters
string
id
Required

Domain ID


Responses
200

Ok

Returns Domain of type(s) application/json
{
    "capacity": {
        "cpu": {
            "total": {
                "unit": "string",
                "value": "number"
            },
            "used": {
                "unit": "string",
                "value": "number"
            }
        },
        "memory": {
            "total": {
                "unit": "string",
                "value": "number"
            },
            "used": {
                "unit": "string",
                "value": "number"
            }
        },
        "storage": {
            "total": {
                "unit": "string",
                "value": "number"
            },
            "used": {
                "unit": "string",
                "value": "number"
            }
        }
    },
    "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
Optional

capacity

clusters
Optional

List of clusters associated with the workload domain

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

nsxtCluster
Optional

nsxtCluster

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

array of Tag
tags
Optional

Deprecated, this list will always be returned empty

string
type
Optional

Type of the workload domain

vcenters
Optional

List of vCenters associated with the workload domain


404

Domain not found

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


500

InternalServerError

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message