Get Cluster

Get Cluster

Get a Cluster

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

Cluster ID

Responses
200

Ok

Returns Cluster of type(s) application/json 
{
    "hosts": [
        {
            "azName": "string",
            "fqdn": "string",
            "id": "string",
            "ipAddress": "string",
            "vmNics": [
                {
                    "isActive": false,
                    "isAutoNegotiateSupported": false,
                    "isInUse": false,
                    "linkSpeedMB": 0,
                    "name": "string"
                }
            ]
        }
    ],
    "id": "string",
    "isDefault": false,
    "isImageBased": false,
    "isStretched": false,
    "name": "string",
    "primaryDatastoreName": "string",
    "primaryDatastoreType": "One among: VSAN, VSAN_ESA, NFS, FC, VVOL_FC, VVOL_ISCSI, VVOL_NFS, VSAN_REMOTE",
    "tags": [
        {
            "categoryId": "string",
            "categoryName": "string",
            "id": "string",
            "name": "string"
        }
    ],
    "vdsSpecs": [
        {
            "isUsedByNsxt": false,
            "mtu": 0,
            "name": "string",
            "niocBandwidthAllocationSpecs": [
                {
                    "niocTrafficResourceAllocation": {
                        "limit": 0,
                        "reservation": 0,
                        "sharesInfo": {
                            "level": "One among: low, normal, high, custom",
                            "shares": 0
                        }
                    },
                    "type": "string"
                }
            ],
            "portGroupSpecs": [
                {
                    "activeUplinks": [
                        "string"
                    ],
                    "name": "string",
                    "transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK, VM_MANAGEMENT"
                }
            ]
        }
    ]
}
array of HostReference
hosts
Optional

List of hosts associated with the cluster

string
id
Optional

ID of the cluster

boolean
isDefault
Optional

Status of the cluster if default or not

boolean
isImageBased
Optional

Is vSphere cluster managed by vSphere Lifecycle Manager - true for managed, false for not managed

boolean
isStretched
Optional

Status of the cluster if Stretched or not

string
name
Optional

Name of the cluster

string
primaryDatastoreName
Optional

Name of the primary datastore

string
primaryDatastoreType
Optional

Storage type of the primary datastore

array of Tag
tags
Optional

Deprecated, this list will always be returned empty

array of VdsSpec
vdsSpecs
Optional

Distributed switches to added to the cluster


404

Cluster not found

Returns Error of type(s) application/json 
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "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"
        }
    ],
    "context": {
        "context": "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


On This Page
Clusters Operations
POST
Add Datastore To Cluster
GET
Assignable Tags To Cluster
PUT
Assign Tags To Existing Cluster
POST
Create Cluster
DELETE
Delete Cluster
GET
Get Cluster
GET
Get Cluster Datastores
GET
Get Clusters
GET
Get Cluster Tag Manager Url
GET
Get Datastore Criterion
GET
Get Datastore Query Response
GET
Get Datastores Criteria
GET
Get Host Criteria
GET
Get Host Criterion
GET
Get Host Query Response
GET
Get Tags Assigned To Cluster
GET
Get Tags Assigned To Clusters
GET
Get Vdses
POST
Post Datastore Query
POST
Post Host Query
DELETE
Remove Datastore From Cluster
DELETE
Remove Tags From Existing Cluster
PATCH
Update Cluster
POST
Validate Cluster Operations
POST
Validate Clusters Operations
POST
Validate Vsan Remote Datastore Spec