Get Supervisor Services Versions
Return the information for the specified Supervisor Service version.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/supervisor-services/{supervisor_service}/versions/{version}
Path Parameters
Path Parameters
string
supervisor_service
Required
Identifier of the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.
string
version
Required
Identifier of the version. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor_services.Version.
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
NamespaceManagementSupervisorServicesVersionsInfo
of type application/json
Information for the specified Supervisor Service version.
{
"EULA": "string",
"content": "string",
"content_type": "VSPHERE_APPS_YAML",
"description": "string",
"display_name": "string",
"state": "ACTIVATED",
"trust_verified": false
}
boolean
trust_verified
Required
If true, the Supervisor Service version is from trusted provider and the trust is verified.
content_type
Required
The Versions.ContentType enumerated type defines the type of content that describes the format of Supervisor Service version definition.
VSPHERE_APPS_YAML : The Supervisor Service version definition is provided as inline YAML document that follows the vSphere application service format.
CARVEL_APPS_YAML : The Supervisor Service version definition is provided as inline YAML document that follows the Carvel application package format.
CUSTOM_YAML : The Supervisor Service version definition is provided as inline YAML document that follows a plain Kubernetes YAML format.
Possible values are: VSPHERE_APPS_YAML , CARVEL_APPS_YAML , CUSTOM_YAML
string
display_name
Required
The human readable name of the Supervisor Service version.
state
Required
The Versions.State enumerated type defines the state of a Supervisor Service version.
ACTIVATED : The is the default state of a Supervisor Service version upon creation. In this state, all operations on the version should work as normal.
DEACTIVATED : The is the deactivated state of a Supervisor Service version. In this state, certain operations on the version are disallowed, for example, the version cannot be created on the vSphere Supervisor clusters.
Possible values are: ACTIVATED , DEACTIVATED
string
content
Optional
Inline content that contains base64 encoded service definition for the version. If unset, no content is available for the Supervisor Service version.
string
description
Optional
A human-readable description of the Supervisor Service version. If unset, no description is available for the Supervisor Service version.
string
EULA
Optional
The End User License Agreement (EULA) associated with the Supervisor Service version. If unset, no EULA is available for the Supervisor Service version.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the System.Read privilege.
404
com.vmware.vapi.std.errors.not_found : if Supervisor Service with the ID supervisorService or version with the ID {param.name version} could not be located.
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-GetSupervisorServiceVersionNamespaceManagement -SupervisorService "MySupervisorService" -Version "MyVersion"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/supervisor-services/{supervisor_service}/versions/{version}
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
