Get Clusters Topology
Queries the Supervisor ID that is currently running on the given vSphere Cluster ID, if there’s any. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/topology
Path Parameters
Path Parameters
string
cluster
Required
Identifier for a vSphere Cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
string
of type application/json
Identifier of the Supervisor associated with the given vSphere Cluster. The result will be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.
Errors
401
com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. if the user cannot be authenticated.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Manage privilege and the System.Read privilege on all vSphere Clusters hosting the Supervisor.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetClusterNamespaceManagementTopology -Cluster "MyCluster"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/topology
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 8.0.0.1
