Vcenter Cluster list

Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Vcenter Cluster FilterSpec.

Request

URI

GET

https://{api_host}/api/vcenter/cluster

COPY

Query Parameters

string of array

clusters

Optional

Identifiers of clusters that can match the filter.

If missing or null or empty, clusters with any identifier match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ClusterComputeResource.

string of array

names

Optional

Names that clusters must have to match the filter (see Vcenter Cluster Info.name).

If missing or null or empty, clusters with any name match the filter.

string of array

folders

Optional

Folders that must contain the cluster for the cluster to match the filter.

If missing or null or empty, clusters in any folder match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Folder. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Folder.

string of array

datacenters

Optional

Datacenters that must contain the cluster for the cluster to match the filter.

If missing or null or empty, clusters in any datacenter match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Datacenter. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Datacenter.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

200

Commonly used information about the clusters matching the Vcenter Cluster FilterSpec.

[
    {
        "cluster": "string",
        "name": "string",
        "ha_enabled": false,
        "drs_enabled": false
    }
]

array of Vcenter Cluster Summary

Optional

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0

"Vapi Std Errors Unauthenticated Object"

string

challenge

Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

403

if the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthorized0

"Vapi Std Errors Unauthorized Object"

500

if more than 1000 clusters match the Vcenter Cluster FilterSpec.

Returns Vapi Std Errors UnableToAllocateResource of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors UnableToAllocateResource0

"Vapi Std Errors UnableToAllocateResource Object"

503

if the system is unable to communicate with a service to complete the request.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0

"Vapi Std Errors ServiceUnavailable Object"

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/cluster

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Vcenter Operations