Get Cluster

Get Cluster

Get the specified Cluster.

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

The ID of the Cluster.

Authentication
This operation uses the following authentication methods.
Responses
200

The specified Cluster has been retrieved.

Returns InlineZtpV1ClustersCluster_id200Response of type(s) application/json 
{
    "id": "string",
    "version": 0,
    "name": "string",
    "type": "string",
    "enabled": false,
    "parentDomainId": "string",
    "parentDomainName": "cdc1",
    "location": {
        "city": "string",
        "country": "string",
        "address": "string",
        "longitude": "number",
        "latitude": "number"
    },
    "licenses": {
        "esxi": [
            "string"
        ],
        "vsan": [
            "string"
        ]
    },
    "switches": [
        {
            "name": "string",
            "uplinks": [
                {
                    "pnic": "string",
                    "name": "string"
                }
            ]
        }
    ],
    "services": [
        {
            "name": "string",
            "type": "string",
            "enabled": false,
            "vsanConfig": {
                "vsanDedup": false
            }
        }
    ],
    "storage": {
        "twoNodeVsanCluster": {
            "witness": {
                "preDeployed": {
                    "witnessHostAddress": "string"
                },
                "ztpDeployed": {
                    "ovaPath": "string",
                    "witnessVMDeployment": {
                        "formFactor": "string",
                        "deploymentTarget": {
                            "clusterName": "string",
                            "resourceGroup": "string",
                            "hostName": "string"
                        },
                        "dataStoreName": "string",
                        "primaryNetwork": {
                            "networkName": "string",
                            "fqdn": "string",
                            "gateway": "string",
                            "prefix": 0
                        },
                        "secondaryNetwork": {
                            "networkName": "string",
                            "fqdn": "string",
                            "gateway": "string",
                            "prefix": 0
                        },
                        "rootPassword": "string"
                    }
                }
            }
        }
    },
    "networks": [
        {
            "type": "string",
            "name": "string",
            "switch": "string",
            "segmentType": "string",
            "vlan": 0,
            "mtu": 0,
            "gateway": "string",
            "prefixLength": 0,
            "mac_learning_enabled": false,
            "uplinkTeamingPolicy": {
                "uplinkPortOrder": {
                    "active": [
                        "string"
                    ],
                    "standby": [
                        "string"
                    ],
                    "unused": [
                        "string"
                    ]
                }
            }
        }
    ],
    "settings": {
        "dns": {
            "suffix": "string",
            "servers": [
                "string"
            ]
        },
        "ntp": {
            "servers": [
                "string"
            ]
        },
        "csiTagging": {
            "enableCsiZoning": false,
            "clusterCsiZoneTagNamingScheme": "string",
            "hostCsiZoneTagNamingScheme": "string"
        },
        "disableDatastoreCustomization": false
    },
    "csiTags": {
        "csiZoneTag": "string"
    },
    "csiCategories": {
        "useExisting": false,
        "zone": "string"
    },
    "hcpId": "string",
    "hcpName": "string",
    "hostCount": 0,
    "status": "string",
    "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
type
Optional

The type of the domain.

boolean
enabled
Optional

Flag indicating whether this domain is enabled or disabled.

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.

array of object
switches
Optional

The list of switches under this domain.

array of object
services
Optional

services

object
storage
Optional

Configuration for two node vsan.

array of object
networks
Optional

The list of networks for the switches under this domain.

object
settings
Optional

settings

object
csiTags
Optional

csiTags

object
csiCategories
Optional

csiCategories

string
hcpId
Optional

The unique ID of the Host Config Profile associated with this domain.

string
hcpName
Optional

The name of the Host Config Profile associated with this domain.

integer
hostCount
Optional

The number of hosts in this domain.

string
status
Optional

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

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 InlineZtpV1ClustersCluster_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 Cluster was not found.

Operation doesn't return any data structure

422

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

Returns InlineZtpV1ClustersCluster_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 InlineZtpV1ClustersCluster_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
Cluster Operations
POST
Create Clusters
DELETE
Delete Cluster
POST
Fetch Cluster By Names
GET
Get Cluster
GET
Get Clusters
GET
Get Status For Cluster
POST
Resync Clusters
PUT
Update Cluster
PUT
Update Clusters