Developer Documentation
List Cluster Compatibility
Released in v7.0.0.0Returns Namespaces compatibility information for all clusters in vCenter matching the ClusterCompatibility.FilterSpec. The result contains only visible (subject to permission checks) clusters.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/cluster-compatibility
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
ClusterCompatibilityFilterSpec | Specification of matching clusters for which information should be returned. If unset, the behavior is equivalent to a ClusterCompatibility.FilterSpec with all fields unset which means all clusters match the filter. |
Response
Response
Response BodyResponse Body
200 OK returns
array of
ClusterCompatibilitySummary
of type application/json
Namespaces compatibility information for the clusters matching the the ClusterCompatibility.FilterSpec.
{
"cluster": "string",
"compatible": false
}| Property Name | Type | Description |
|---|---|---|
| cluster | string |
Identifier of the cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource. |
| compatible | boolean |
Compatibility of this cluster. |
| incompatibility_reasons | array of Std_LocalizableMessage |
Reasons for incompatibility. |
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 does not have System.Read privilege. |
| 404 | Error | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. |
| 500 | Error | com.vmware.vapi.std.errors.internal_server_error : if the server reports an unknown internal error. |
