Get Cluster
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Retrieves information about the cluster corresponding to cluster.
Request
URLURL
https://{api_host}/rest/vcenter/cluster/{cluster}
Parameters
Parameters
string
cluster
Required
Identifier of the cluster to be deleted.
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
Example: b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
ClusterGetResponseBody
of type application/json
Information about the cluster associated with cluster.
{
"value": {
"name": "string",
"resource_pool": "string"
}
}cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/cluster/{cluster}
Errors
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
401
com.vmware.vapi.std.errors.unauthenticated : if the session id is missing from the request or the corresponding session object cannot be found. | 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.
Cluster Operations
get
get
