This API has a deprecated equivalent from v7.0U1.
List Cluster
Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec.
Request
URLURL
https://{api_host}/api/vcenter/cluster
Query Parameters
Query Parameters
array of
string
clusters
Optional
Identifiers of clusters that can match the filter. If unset or empty, clusters with any identifier match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: ClusterComputeResource.
array of
string
datacenters
Optional
Datacenters that must contain the cluster for the cluster to match the filter. If unset or empty, clusters in any datacenter match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Datacenter. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Datacenter.
array of
string
folders
Optional
Folders that must contain the cluster for the cluster to match the filter. If unset or empty, clusters in any folder match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Folder. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Folder.
array of
string
names
Optional
Names that clusters must have to match the filter (see Cluster.Info.name). If unset or empty, clusters with any name match the filter.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
ClusterSummary
of type application/json
Commonly used information about the clusters matching the Cluster.FilterSpec.
[
{
"cluster": "string",
"drs_enabled": false,
"ha_enabled": false,
"name": "string"
}
]
string
cluster
Required
Identifier of the cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.
boolean
drs_enabled
Required
Flag indicating whether the vSphere DRS service is enabled for the cluster.
boolean
ha_enabled
Required
Flag indicating whether the vSphere HA feature is enabled for the cluster.
string
name
Required
Name of the cluster.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.unable_to_allocate_resource : if more than 1000 clusters match the Cluster.FilterSpec.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListCluster -Clusters "MyClusters" -Names "MyNames" -Folders "MyFolders" -Datacenters "MyDatacenters"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/cluster
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/cluster
x-vmw-doc-operation: list
Availability
Added in 7.0U2
On This Page
Cluster Operations
get
get
