Vcenter NamespaceManagement ClusterCompatibility listV2

Vcenter NamespaceManagement ClusterCompatibility listV2

Returns Namespaces compatibility information for all vSphere clusters that match the Vcenter NamespaceManagement ClusterCompatibility FilterSpecV2 and are associated with the vSphere Zones in the vCenter Server that match the Vcenter NamespaceManagement ClusterCompatibility ZoneFilterSpec. The result contains only visible (subject to permission checks) clusters.

This operation was added in vSphere API 8.0.0.1.

Request
URI
GET
https://{api_host}/api/vcenter/namespace-management/cluster-compatibility/v2
COPY
Query Parameters
string of array
zones
Optional

A list of vSphere Zone identifiers which will be used to filter vSphere Zones that correspond to this specific set of identifiers.

This property was added in vSphere API 8.0.0.1.

If missing or null or empty, results will not be filtered for specific vSphere Zone identifiers.

clusterFilter
Optional

Specification of matching vSphere clusters for which information should be returned.

If missing or null, the behavior is equivalent to a Vcenter NamespaceManagement ClusterCompatibility FilterSpecV2 with all properties missing or null which means all NSX clusters the user is authorized to view will be returned.


Authentication
This operation uses the following authentication methods.
Responses
200

Namespaces compatibility information for vSphere Zones that match the Vcenter NamespaceManagement ClusterCompatibility ZoneFilterSpec and the vSphere clusters associated with them that match the Vcenter NamespaceManagement ClusterCompatibility FilterSpecV2.

"Vcenter NamespaceManagement ClusterCompatibility ZoneCompatibilityInfo Object"
boolean
compatible
Required

Flag to indicate whether the vSphere Zones are compatible with each other. If false, the list of incompatibility issues will be given in the incompatibility_reasons field.

This property was added in vSphere API 8.0.0.1.

array of object
zone_summaries
Required

Information about the compatibility of a list of vSphere Zones and the vSphere clusters associated with them.

This property was added in vSphere API 8.0.0.1.

array of object
incompatibility_reasons
Required

Reasons for incompatibility between the vSphere Zones.

This property was added in vSphere API 8.0.0.1.


400

if zoneFilter or clusterFilter contain any errors.

Returns Vapi Std Errors InvalidArgument of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0
"Vapi Std Errors InvalidArgument Object"

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


403

if the user does not have System.Read privilege on the vSphere clusters associated with the vSphere Zones.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0
"Vapi Std Errors Unauthorized Object"

500

if the system reports an error while responding to the request.

Returns Vapi Std Errors Error of type(s) application/json
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/namespace-management/cluster-compatibility/v2