NamespaceManagementClustersSummary

The Clusters.Summary structure contains the basic information about the cluster statistics and status related to vSphere Namespaces.


Properties

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

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: CONFIGURINGREMOVINGRUNNINGERROR


kubernetes_status Required

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: READYWARNINGERROR


stats Required

Basic runtime statistics for the cluster.

JSON Example

{
    "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
    }
}
Returned By

List Clusters

Feedback

Was this page helpful?