REST API - list
  1. Operations
  2. vcenter
  3. namespace management
  4. clusters

vcenter namespace management clusters: list

Returns information about all clusters on which vSphere Namespaces are enabled on this vCenter.

Request:

HTTP request

GET https://{server}/api/vcenter/namespace-management/clusters

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "cluster" : "obj-103",
        "cluster_name" : "obj-103",
        "stats" : {
            "cpu_used" : 1,
            "storage_capacity" : 1,
            "memory_used" : 1,
            "cpu_capacity" : 1,
            "memory_capacity" : 1,
            "storage_used" : 1
        },
        "kubernetes_status" : "READY",
        "config_status" : "CONFIGURING"
    },
    {
        "cluster" : "obj-103",
        "cluster_name" : "obj-103",
        "stats" : {
            "cpu_used" : 1,
            "storage_capacity" : 1,
            "memory_used" : 1,
            "cpu_capacity" : 1,
            "memory_capacity" : 1,
            "storage_used" : 1
        },
        "kubernetes_status" : "READY",
        "config_status" : "CONFIGURING"
    }
]

Headers:

None

Type:

Name Type Description
bold = required
- summary[] List of summary of all clusters with vSphere Namespaces enabled.
-[].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.
-[].stats stats Basic runtime statistics for the cluster.
-[].stats.cpu_used long Overall CPU usage of the cluster, in MHz. This is the sum of CPU usage across all worker nodes in the cluster.
-[].stats.cpu_capacity long Total CPU capacity in the cluster available for vSphere Namespaces, in MHz. This is the sum of CPU capacities from all worker nodes in the cluster.
-[].stats.memory_used long Overall memory usage of the cluster, in mebibytes. This is the sum of memory usage across all worker nodes in the cluster.
-[].stats.memory_capacity long Total memory capacity of the cluster available for vSphere Namespaces, in mebibytes. This is the sum of memory capacities from all worker nodesin the cluster.
-[].stats.storage_used long Overall storage used by the cluster, in mebibytes. This is the sum of storage used across all worker nodes in the cluster.
-[].stats.storage_capacity long Overall storage capacity of the cluster available for vSphere Namespaces, in mebibytes. This is the sum of total storage available from all worker nodes in the cluster.
-[].config_status string Current setting for config_status.

Describes the status of reaching the desired state configuration for the cluster. Value is one of:
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.
-[].kubernetes_status string Current setting for kubernetes_status.

Describes the cluster's ability to deploy pods. Value is one of:
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.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user does not have System.Read privilege.