Developer Documentation
List Cluster
Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec.
Request
URLURL
https://{api_host}/rest/vcenter/cluster
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
ClusterFilterSpec | Specification of matching clusters for which information should be returned. If unset, the behavior is equivalent to a Cluster.FilterSpec with all fields unset which means all clusters match the filter. |
Response
Response
Response BodyResponse Body
200 OK returns
ListResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: Commonly used information about the clusters matching the Cluster.FilterSpec.
{
"value": [
{
"cluster": "string",
"drs_enabled": false,
"ha_enabled": false,
"name": "string"
}
]
}| Property Name | Type | Description |
|---|---|---|
| value | array of ClusterSummary |
Commonly used information about the clusters matching the Cluster.FilterSpec. |
Errors
| Code | Returns | Description |
|---|---|---|
| default | Error | Not available |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| 507 | Error | com.vmware.vapi.std.errors.unable_to_allocate_resource : if more than 1000 clusters match the Cluster.FilterSpec. |
On This Page
Cluster Operations
get
get
