Get Sddc Manager

Get Sddc Manager

Retrieve the details of an SDDC Manager by its id

Request
URI
GET
https://{api_host}/v1/sddc-managers/{id}
COPY
Path Parameters
string
id
Required

Sddc Manager ID

Responses
200

Ok

Returns SddcManager of type(s) application/json 
{
    "domain": {
        "id": "string",
        "name": "string",
        "type": "string"
    },
    "basicAuthDetails": {
        "status": "One among: ENABLED, DISABLED",
        "username": "string"
    },
    "id": "string",
    "fqdn": "string",
    "version": "string",
    "ipAddress": "string"
}
DomainReference
domain
Optional

Represents a domain reference

BasicAuthDetails
basicAuthDetails
Optional

Basic auth details

string
id
Optional

ID of the SDDC Manager

string
fqdn
Optional

FQDN of the SDDC Manager

string
version
Optional

Version of the SDDC Manager

string
ipAddress
Optional

IP Address of the SDDC Manager


404

Sddc Manager 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.

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.


On This Page
Sddc Managers Operations
GET
Get Local Os User Accounts
GET
Get Sddc Manager
GET
Get Sddc Manager History
GET
Get Sddc Managers