Get Supervisors Topology
Queries the current association between vSphere Zones and vSphere Clusters from the given Supervisor ID. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. Use the vSphere Cluster IDs obtained from Topology.get to call the APIs that requires a vSphere Cluster ID instead of a Supervisor.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/supervisors/{supervisor}/topology
Path Parameters
Path Parameters
string
supervisor
Required
Identifier for a Supervisor. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.
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
array of
NamespaceManagementSupervisorsTopologyInfo
of type application/json
List of Topology.Info of vSphere Zone and vSphere Cluster associations.
[
{
"clusters": [
"string"
],
"zone": "string"
}
]
array of
string
clusters
Required
A list of vSphere Cluster identifiers that are associated with the vSphere Zone. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: ClusterComputeResource.
string
zone
Required
Identifier of this vSphere Zone. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone. When operations return a value of this structure as a result, the field 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-GetSupervisorNamespaceManagementTopology -Supervisor "MySupervisor"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/supervisors/{supervisor}/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
