This API has a deprecated equivalent from v7.0U1.
Get Cluster
Retrieves information about the cluster corresponding to cluster. if you do not have all of the privileges described as follows: - The resource ClusterComputeResource referenced by the parameter cluster requires System.Read.
Request
URLURL
https://{api_host}/api/vcenter/cluster/{cluster}
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
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
ClusterInfo
of type application/json
Information about the cluster associated with cluster.
{
"name": "string",
"resource_pool": "string"
}
string
name
Required
The name of the cluster
string
resource_pool
Required
Identifier of the root resource pool of the cluster When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ResourcePool. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ResourcePool.
Errors
401
com.vmware.vapi.std.errors.unauthenticated : if the session id is missing from the request or the corresponding session object cannot be found.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t not have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if there is no cluster associated with cluster in the system.
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-GetCluster -Cluster "MyCluster"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/cluster/{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/{cluster}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Cluster Operations
get
get
