Get Supervisor Services Cluster Supervisor Services
Return information about the specific Supervisor Service on the specified vSphere Supervisor. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/supervisor-services/{supervisor_service}
Path Parameters
Path Parameters
string
cluster
Required
Identifier for the cluster on which to get the service. The parameter must be an identifier for the resource type: ClusterComputeResource.
string
supervisor_service
Required
Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.
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
NamespaceManagementSupervisorServicesClusterSupervisorServicesInfo
of type application/json
The information for the specified Supervisor Service on the specified cluster.
{
"config_status": "CONFIGURING",
"current_version": "string",
"description": "string",
"desired_version": "string",
"display_name": "string",
"messages": [
{
"details": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"severity": "INFO"
}
],
"prefix": "string",
"service_namespace": "string",
"yaml_service_config": "string"
}
config_status
Required
The ClusterSupervisorServices.ConfigStatus enumerated type describes the status of reaching the desired state configuration for the Supervisor Service.
CONFIGURING : The Supervisor Service is being installed.
REMOVING : The Supervisor Service is being deleted.
CONFIGURED : The Supervisor Service has been configured correctly (i.e. the provided YAML content has been applied successfully to the cluster)
ERROR : Failed to install the Supervisor Service, user intervention needed.
Possible values are: CONFIGURING , REMOVING , CONFIGURED , ERROR
string
desired_version
Required
The desired version of this Supervisor Service.
string
display_name
Required
A human readable name of the Supervisor Service.
messages
Required
Current set of messages associated with the Supervisor Service on the vSphere Supervisor.
string
current_version
Optional
The current version for the Supervisor Service. If unset, there is no version installed for the Supervisor Service.
string
description
Optional
A human readable description of the Supervisor Service. If unset, the description for the service version is empty.
string
prefix
Optional
The prefix that will be added to the names of the Supervisor Service’s kubernetes resources. If unset, the prefix is not assigned yet.
string
service_namespace
Optional
Identifier of the namespace to allocate the Supervisor Service’s operators. If unset, there is an error when creating the service namespace or the namespace has not been created yet. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.
string
yaml_service_config
Optional
The configuration parameters applied on this Supervisor Service, formatted as a base64 encoded YAML document. Any configuration that has been set will be returned as base64 encoded YAML, including the ClusterSupervisorServices.CreateSpec.service-config. If unset, the Supervisor Service has no configuration applied.
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the Supervisor doesn’t support Supervisor Services.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have the SupervisorServices.Manage privilege on the specified cluster.
404
com.vmware.vapi.std.errors.not_found : if Supervisor with the ID cluster or the Supervisor Service does not exist on 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-GetClusterSupervisorServiceNamespaceManagement -Cluster "MyCluster" -SupervisorService "MySupervisorService"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/supervisor-services/{supervisor_service}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.3.0
