Get Vcenter

Get Vcenter

Get the specified vCenter.

Request
URI
GET
https://{api_host}/hybridity/api/ztp/v1/vcenters/{vcenter_id}
COPY
Path Parameters
string
vcenter_id
Required

The ID of the vCenter.

Authentication
This operation uses the following authentication methods.
Responses
200

The specified vCenter.

Returns InlineZtpV1VcentersVcenter_id200Response of type(s) application/json 
{
    "id": "string",
    "version": 0,
    "name": "string",
    "datacenter": "string",
    "type": "string",
    "parentDomainId": "string",
    "parentDomainName": "cdc1",
    "location": {
        "city": "string",
        "country": "string",
        "address": "string",
        "longitude": "number",
        "latitude": "number"
    },
    "licenses": {
        "esxi": [
            "string"
        ],
        "vsan": [
            "string"
        ]
    },
    "vcenter": {
        "fqdn": "string",
        "username": "string",
        "password": "string",
        "thumbprintSha256": "06:69:51:27:c6:bc:32:3e:02:a4:e4:3c:2e:9e:75:78:9e:b7:d4:9c:11:51:72:cc:c4:45:13:22:a4:36:f3:e5"
    },
    "status": "string",
    "isVcpResyncNeeded": false,
    "createdTimestamp": 0,
    "lastUpdatedTimestamp": 0,
    "messages": {
        "warnings": [
            {
                "code": "string",
                "message": "string",
                "stack": "string"
            }
        ],
        "errors": [
            {
                "code": "string",
                "message": "string",
                "stack": "string"
            }
        ]
    }
}
string
id
Optional

The unique ID of the domain.

integer
version
Optional

The version of this domain entity.

string
name
Optional

The name of the domain.

string
datacenter
Optional

datacenter

string
type
Optional

The type of the domain.

string
parentDomainId
Optional

The unique ID of the parent domain for this domain. Central Site and Regional Site type domains of sub type MANAGEMENT can't have parent as they themselves are the parents for other domains.

string
parentDomainName
Optional

The name of the parent domain for this domain. Central Site and Regional Site type domains of sub type MANAGEMENT can't have parent as they're the bases for the other domains.

object
location
Optional

The location of the domain.

object
licenses
Optional

The license keys required for the domain.

object
vcenter
Optional

vcenter

string
status
Optional

The status of provisioning of the domain. It can be one of: [NOT_PROVISIONED, PROVISIONED, IN_PROGRESS, FAILED].

boolean
isVcpResyncNeeded
Optional

This flag specifies whether a resync is needed for this vCenter domain to validate the latest specifications.

integer As int64 As int64
createdTimestamp
Optional

The timestamp of when this domain was created.

integer As int64 As int64
lastUpdatedTimestamp
Optional

The timestamp of when this domain was last modified.

object
messages
Optional

The messages for this domain. They may include warnings and errors.


301

API endpoint has permanently moved.

Returns InlineZtpV1VcentersVcenter_id301Response of type(s) application/json 
{
    "redirectURL": "string"
}
string
redirectURL
Optional

redirectURL

Response Headers

string
Location

URI where the client will find the new endpoint.


401

User is not authenticated to invoke this endpoint.

Operation doesn't return any data structure

403

User is not authorized to invoke this endpoint.

Operation doesn't return any data structure

404

The specified vCenter was not found.

Operation doesn't return any data structure

422

The request parameters couldn't be processed by the server.

Returns InlineZtpV1VcentersVcenter_id422Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


500

An internal server error has occurred.

Returns InlineZtpV1VcentersVcenter_id500Response of type(s) application/json 
{
    "warnings": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "stack": "string"
        }
    ]
}
array of object
warnings
Optional

The list of warnings.

array of object
errors
Optional

The list of errors.


On This Page
V Center Operations
POST
Create Vcenters
DELETE
Delete Vcenter
POST
Fetch Vcenter By Names
GET
Get Status For Vcenter
GET
Get Vcenter
GET
Get V Center Certificate
GET
Get Vcenters
PATCH
Patch Vcenter
POST
Resync Vcenters
PUT
Update Vcenter
PUT
Update Vcenters
POST
Validate Vcenter