Developer Documentation
List Clusters
Released in v7.0.0.0Returns information about all clusters on which vSphere Namespaces are enabled on this vCenter.
Request
Operation doesn't accept any path, query or header parameters.
URL
https://{api_host}/api/vcenter/namespace-management/clusters
Response
Response
Response BodyResponse Body
200 OK returns
array of
ClustersSummary
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
}
}| Property Name | Type | Description |
|---|---|---|
| cluster | string |
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. |
| cluster_name | string |
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 | ClustersConfigStatus Enum |
Current setting for Clusters.ConfigStatus. |
| kubernetes_status | ClustersKubernetesStatus Enum |
Current setting for Clusters.KubernetesStatus. |
| stats | ClustersStats |
Basic runtime statistics for the cluster. |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege. |
| 404 | Error | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. |
| default | Error | Not available |
On This Page
Clusters Operations
get
put
patch
get
post
post
