Retrieves a specified cluster profile summary

GET 
/v1/dashboard/clusterprofiles/:uid

Retrieves a specified cluster profile summary

Request

Path Parameters

uid stringrequired

Header Parameters

ProjectUid string

Scope the request to the specified project uid

Responses

200

Cluster profile summary response

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

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

specSummary

object

Cluster profile spec summary

draft

object

Cluster profile template summary

cloudTypestring

packs

undefined[]

Array [

addonTypestring

annotations

object

property name*string

displayNamestring

layerstring

Possible values: [kernel, os, k8s, cni, csi, addon]

logoUrlstring

namestring

packUidstring

tagstring

typestring

versionstring

]

typestring

published

object

Cluster profile template summary

cloudTypestring

packs

undefined[]

Array [

addonTypestring

annotations

object

property name*string

displayNamestring

layerstring

Possible values: [kernel, os, k8s, cni, csi, addon]

logoUrlstring

namestring

packUidstring

tagstring

typestring

versionstring

]

typestring

versionstring

Cluster profile's latest version

versions

undefined[]

Cluster profile's list of all the versions

Array [

uidstring

versionstring

]

status

object

ClusterProfileStatusSummary defines the observed state of ClusterProfile

fips

Cluster profile fips compliance status

modestring

Possible values: [full, none, partial, unknown]

Default value: none

inUseClusterUidsstring[]

Deprecated. Use inUseClusters

inUseClusters

object[]

Array [

namestring

uidstring

]

isPublishedboolean

pack

object

Cluster profile packs summary about the deprecated, disabled, deleted packs count

deletednumber

Total count of deleted packs in a cluster profile

deprecatednumber

Total count of deprecated packs in a cluster profile

disablednumber

Total count of disabled packs in a cluster profile

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "creationTimestamp": "2024-07-02T18:20:57.813Z",
    "deletionTimestamp": "2024-07-02T18:20:57.813Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-07-02T18:20:57.813Z",
    "name": "string",
    "uid": "string"
  },
  "specSummary": {
    "draft": {
      "cloudType": "string",
      "packs": [
        {
          "addonType": "string",
          "annotations": {},
          "displayName": "string",
          "layer": "kernel",
          "logoUrl": "string",
          "name": "string",
          "packUid": "string",
          "tag": "string",
          "type": "string",
          "version": "string"
        }
      ],
      "type": "string"
    },
    "published": {
      "cloudType": "string",
      "packs": [
        {
          "addonType": "string",
          "annotations": {},
          "displayName": "string",
          "layer": "kernel",
          "logoUrl": "string",
          "name": "string",
          "packUid": "string",
          "tag": "string",
          "type": "string",
          "version": "string"
        }
      ],
      "type": "string"
    },
    "version": "string",
    "versions": [
      {
        "uid": "string",
        "version": "string"
      }
    ]
  },
  "status": {
    "fips": {
      "mode": "none"
    },
    "inUseClusterUids": [
      "string"
    ],
    "inUseClusters": [
      {
        "name": "string",
        "uid": "string"
      }
    ],
    "isPublished": true,
    "pack": {
      "deleted": 0,
      "deprecated": 0,
      "disabled": 0
    }
  }
}

Loading...