This API has a deprecated equivalent from v7.0U1.
Get Cluster
Retrieves information about the cluster corresponding to cluster.
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, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389Authentication
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.
PowerCLI Client SDK Example
Invoke-GetCluster -Cluster "MyCluster"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/cluster/{cluster}
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.
Availability
Added in 7.0U2
On This Page
Cluster Operations
get
get
