more than half documented
List Cluster Compatibility
DescriptionReturns 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
filter
Optional
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.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespaceManagementClusterCompatibilitySummary of type application/json
Namespaces compatibility information for the clusters matching the the ClusterCompatibility.FilterSpec.
{
"cluster": "string",
"compatible": false,
"incompatibility_reasons": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
]
}
string
cluster
Required
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.
boolean
compatible
Required
Compatibility of this cluster.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/cluster-compatibility
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.internal_server_error : if the server reports an unknown internal error.
Availability
Added in 7.0.0.0
