vcenter cluster: get
Retrieves information about the cluster corresponding to
cluster.
Request:
HTTP request
GET https://{server}/rest/vcenter/cluster/{cluster}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| cluster | string | Identifier of the cluster. |
Response:
HTTP Status Code: 200
Representation:
{
"value": {
"name": "string",
"resource_pool": "obj-103"
}
}
"value": {
"name": "string",
"resource_pool": "obj-103"
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | info | The vcenter.cluster.info instances that corresponds to the cluster. |
| value.name | string | The name of the cluster |
| value.resource_pool | string | 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:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | if there is no cluster associated with cluster in the system. |
| 503 | service_unavailable | if the system is unable to communicate with a service to complete the request. |
| 401 | unauthenticated | if the session id is missing from the request or the corresponding session object cannot be found. |
| 403 | unauthorized | if the user doesn't not have the required privileges. |