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 are system generated key value metadata for the resource. As an input certain annotations like description can be set.

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

Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag

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 of the resource.

uidstring

UID is the unique identifier generated for the resource. This is not an input field for any request.

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-05-03T21:06:53.962Z",
    "deletionTimestamp": "2024-05-03T21:06:53.962Z",
    "labels": {},
    "lastModifiedTimestamp": "2024-05-03T21:06:53.962Z",
    "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...