List Supervisors Summary
Queries the current state of all Supervisors. Optionally, apply the filter to Supervisors that match the criteria in the Summary.FilterSpec.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/supervisors/summaries
Query Parameters
Query Parameters
config_status
Optional
Matches Supervisors with Summary.Info.config-status equal to the specified value. if unset this filter is not applied.
kubernetes_status
Optional
Matches Supervisors with the Summary.Info.kubernetes-status equal to the specified value. if unset this filter is not applied.
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
NamespaceManagementSupervisorsSummaryListResult
of type application/json
ListResult of Summary.Info of all Supervisors matching the criteria in the Summary.FilterSpec.
{
"items": [
{
"info": {
"config_status": "CONFIGURING",
"kubernetes_status": "READY",
"name": "string",
"stats": {
"cpu_capacity": 0,
"cpu_used": 0,
"memory_capacity": 0,
"memory_used": 0,
"storage_capacity": 0,
"storage_used": 0
}
},
"supervisor": "string"
}
]
}
Errors
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.
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-ListNamespaceManagementSupervisorsSummaries -ConfigStatus "CONFIGURING" -KubernetesStatus "READY"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/supervisors/summaries
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 8.0.0.1
