Get Supervisors Summary
Queries the current state of the specified Supervisor.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/supervisors/{supervisor}/summary
Path Parameters
Path Parameters
string
supervisor
Required
the 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
NamespaceManagementSupervisorsSummaryInfo
of type application/json
Summary.Info of the Supervisor matching the provided identifier.
{
"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
}
}
config_status
Required
The Summary.ConfigStatus enumerated type describes the status of reaching the desired state configuration for the Supervisor.
CONFIGURING : The Namespace configuration is being applied to the Supervisor.
REMOVING : The Namespace configuration is being removed from the Supervisor.
RUNNING : The Supervisor is configured correctly with the Namespace configuration.
ERROR : Failed to apply the Namespace configuration to the Supervisor, user intervention needed.
Possible values are: CONFIGURING , REMOVING , RUNNING , ERROR
kubernetes_status
Required
The Summary.KubernetesStatus enumerated type describes the Supervisor’s ability to deploy pods.
READY : The Supervisor is able to accept pods.
WARNING : The Supervisor may be able to accept pods, but has warning messages.
ERROR : The Supervisor may not be able to accept pods and has error messages.
Possible values are: READY , WARNING , ERROR
string
name
Required
Name of the Supervisor.
stats
Required
Basic runtime statistics for the Supervisor.
Errors
401
com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. if the user can not 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-GetSupervisorNamespaceManagementSummary -Supervisor "MySupervisor"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/supervisors/{supervisor}/summary
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
