Get Namespace Self Service
Returns information about Namespace Self Service of a specific cluster. 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/namespaces/namespace-self-service/{cluster}
Path Parameters
Path Parameters
string
cluster
Required
Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.
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
NamespacesNamespaceSelfServiceInfo
of type application/json
Information about the namespace self service associated with the specified cluster.
{
"capability": "UNKNOWN",
"cluster": "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"
}
],
"status": "CONFIGURING"
}
capability
Required
The NamespaceSelfService.Capability enumerated type describes the self-service namespace capability of the cluster on which vSphere Namespaces enabled.
UNKNOWN : The initial value that represents the in-progress activity of determining the cluster’s self-service namespace capability.
SUPPORTED : The value that indicates the cluster supports self-service namespace capability. The expected transition UNKNOWN –> SUPPORTED
NOTSUPPORTED : The value that indicates the cluster doesn’t support the self-service namespace capability. The expected transition UNKNOWN –> NOTSUPPORTED
Possible values are: UNKNOWN , SUPPORTED , NOTSUPPORTED
string
cluster
Required
Identifier for the cluster to which namespace service is associated. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.
array of
NamespacesInstancesMessage
messages
Required
Current set of messages associated with the object.
status
Required
The page describes the status of the namespace self-service on the cluster on which vSphere Namespaces enabled.
CONFIGURING : The configuration is being applied to the service.
RUNNING : The namespace self service is configured correctly. The expected transitions: 1. CONFIGURING –> RUNNING 2. RUNNING –> CONFIGURING. This transition occurs in the below scenarios: a. When different Dev Users/Groups are empowered with self-service namespace access. b. To reconcile the state of the cluster after the cluster upgrade.
REMOVING : The configuration is being removed and service is being deleted. The expected transitions: 1. CONFIGURING –> RUNNING –> REMOVING 2. CONFIGURING –> REMOVING
DEACTIVATED : The namespace self service is deactivated. This status also represents the initial status of the service before activation. The expected transitions after the service is activated: 1. CONFIGURING –> RUNNING –> REMOVING –> DEACTIVATED 2. CONFIGURING –> REMOVING –> DEACTIVATED
ERROR : Failed to apply the configuration to the namespace self-service or unable to deactivate the namespace self-service, user intervention needed. The expected transitions: 1. CONFIGURING –> ERROR 2. CONFIGURING –> RUNNING –> ERROR 3. CONFIGURING –> RUNNING –> REMOVING –> ERROR 4. CONFIGURING –> REMOVING –> ERROR The NamespaceSelfService.Info.messages field captures the relevant error messages explaining this ERROR status.
Possible values are: CONFIGURING , RUNNING , REMOVING , DEACTIVATED , ERROR
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
404
com.vmware.vapi.std.errors.not_found : if cluster with vSphere Namespaced enabled 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-GetClusterNamespacesNamespaceSelfService -Cluster "MyCluster"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespaces/namespace-self-service/{cluster}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.2.00100
