Returns the specified cluster groups

GET 
/v1/clustergroups/:uid

Returns the specified cluster groups

Request

Path Parameters

uid stringrequired

Responses

200

OK

application/json

Schema

Schema

metadata

object

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

annotations

object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

namespacestring

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

resourceVersionstring

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

selfLinkstring

SelfLink is a URL representing this object. Populated by the system. Read-only.

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

spec

Cluster group specifications

clusterRefs

undefined[]

Array [

clusterNamestring

clusterUidstring

]

clustersConfig

Clusters config of cluster group

endpointTypestring

Possible values: [Ingress, LoadBalancer]

Host cluster endpoint type

hostClustersConfig

undefined[]

Array [

clusterUidstring

endpointConfig

host cluster endpoint configuration

ingressConfig

Ingress configuration for exposing the virtual cluster's kube-apiserver

hoststring

portint64

loadBalancerConfig

Load balancer configuration for exposing the virtual cluster's kube-apiserver

externalIPsstring[]

externalTrafficPolicystring

loadBalancerSourceRangesstring[]

]

limitConfig

Cluster group limit config

cpuint32

Deprecated. Use field cpuMilliCore

cpuMilliCoreint32

CPU in milli cores

memoryint32

Deprecated. Use field memoryMiB

memoryMiBint32

Memory in MiB

overSubscriptionint32

Over subscription percentage

storageGiBint32

Storage in GiB

valuesstring

typestring

Possible values: [hostCluster]

status

Cluster group status

isActiveboolean

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-29T15:51:28.071Z",
    "deletionTimestamp": "2024-07-29T15:51:28.071Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-29T15:51:28.071Z",
    "name": "string",
    "namespace": "string",
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "clusterRefs": [
      {
        "clusterName": "string",
        "clusterUid": "string"
      }
    ],
    "clustersConfig": {
      "endpointType": "Ingress",
      "hostClustersConfig": [
        {
          "clusterUid": "string",
          "endpointConfig": {
            "ingressConfig": {
              "host": "string",
              "port": 0
            },
            "loadBalancerConfig": {
              "externalIPs": [
                "string"
              ],
              "externalTrafficPolicy": "string",
              "loadBalancerSourceRanges": [
                "string"
              ]
            }
          }
        }
      ],
      "limitConfig": {
        "cpu": 0,
        "cpuMilliCore": 0,
        "memory": 0,
        "memoryMiB": 0,
        "overSubscription": 0,
        "storageGiB": 0
      },
      "values": "string"
    },
    "type": "hostCluster"
  },
  "status": {
    "isActive": true
  }
}

Loading...