List Clusters
Returns information about all clusters on which vSphere Namespaces are enabled on this vCenter.
Request
URLURL
Header Parameters
Header Parameters
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
Response
Response BodyResponse Body
array
of
NamespaceManagementClustersSummary of type application/json
List of summary of all clusters with vSphere Namespaces enabled.
[
{
"cluster": "string",
"cluster_name": "string",
"config_status": "CONFIGURING",
"kubernetes_status": "READY",
"stats": {
"cpu_capacity": 0,
"cpu_used": 0,
"memory_capacity": 0,
"memory_used": 0,
"storage_capacity": 0,
"storage_used": 0
}
}
]
Identifier for the cluster. 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.
Name of the cluster. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource.name. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.name.
The Clusters.ConfigStatus enumerated type describes the status of reaching the desired state configuration for the cluster.
CONFIGURING : The Namespace configuration is being applied to the cluster.
REMOVING : The Namespace configuration is being removed from the cluster.
RUNNING : The cluster is configured correctly with the Namespace configuration.
ERROR : Failed to apply the Namespace configuration to the cluster, user intervention needed.
Possible values are: CONFIGURING , REMOVING , RUNNING , ERROR
The Clusters.KubernetesStatus enumerated type describes the cluster’s ability to deploy pods.
READY : The cluster is able to accept pods.
WARNING : The cluster may be able to accept pods, but has warning messages.
ERROR : The cluster may not be able to accept pods and has error messages.
Possible values are: READY , WARNING , ERROR
Errors
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
cURL Command
Vendor Extensions
x-vmw-doc-operation: list