Get Cluster

Get Cluster

Retrieves a Compute Cluster.

Request
URI
GET
https://{api_host}/cloudapi/vcf/clusters/{clusterUrn}
COPY
Path Parameters
string
clusterUrn
Required

clusterUrn

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ComputeCluster of type(s) application/json;version=40.0 
{
    "id": "string",
    "address": "10.1.2.3",
    "virtualCenter": {
        "name": "string",
        "id": "string"
    },
    "moref": "string",
    "supervisor": {
        "name": "string",
        "id": "string"
    },
    "zone": {
        "name": "string",
        "id": "string"
    }
}
string
id
Optional

Identifier for this cluster. This is immutable.

string
address
Optional

The address or hostname or FQDN of the Supervisor if enabled on this cluster.

object
virtualCenter
Optional

Entity reference used to describe VCD entities

string
moref
Optional

The MoRef of the Compute Cluster.

object
supervisor
Optional

Entity reference used to describe VCD entities

object
zone
Optional

Entity reference used to describe VCD entities


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/vcf/clusters/{clusterUrn}
Availability
Added in 40.0
On This Page
Supervisor Clusters Operations
GET
Get Supervisors
GET
Get Supervisor
GET
Get Clusters
GET
Get Cluster
GET
Get Zones
GET
Get Zone
GET
Query VM Class Reservations