more than half documented
List Clusters
Returns information about all clusters on which vSphere Namespaces are enabled on this vCenter.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespaceManagementClustersSummary of type application/json
List of summary of all clusters with vSphere Namespaces enabled.
{
"cluster": "string",
"cluster_name": "string",
"config_status": "enum",
"kubernetes_status": "enum",
"stats": {
"cpu_capacity": 0,
"cpu_used": 0,
"memory_capacity": 0,
"memory_used": 0,
"storage_capacity": 0,
"storage_used": 0
}
}
string
cluster
Required
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.
string
cluster_name
Required
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.
config_status
Required
Current setting for Clusters.ConfigStatus.
Possible values are: CONFIGURING , REMOVING , RUNNING , ERROR
kubernetes_status
Required
Current setting for Clusters.KubernetesStatus.
Possible values are: READY , WARNING , ERROR
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/clusters
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
Availability
Added in 7.0.0.0
On This Page
Clusters Operations
get
get
put
patch
post
post
