Developer Documentation
Get Cluster
Retrieves information about the cluster corresponding to cluster.
Request
URLURL
https://{api_host}/rest/vcenter/cluster/{cluster}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource. |
Response
Response
Response BodyResponse Body
200 OK returns
GetResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: The Cluster.Info instances that corresponds to the cluster.
{
"value": {
"name": "string",
"resource_pool": "string"
}
}| Property Name | Type | Description |
|---|---|---|
| value | ClusterInfo |
The Cluster.Info instances that corresponds to the cluster. |
Errors
| Code | Returns | Description |
|---|---|---|
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| default | Error | Not available |
| 401 | Error | 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 | Error | com.vmware.vapi.std.errors.not_found : if there is no cluster associated with cluster in the system. |
On This Page
Cluster Operations
get
get
