Retrieves a list of cluster profiles filter summary Supported filter fields - ['profileName', 'tags', 'profileType', 'environment'] Supported sort fields - ['profileName', 'environment', 'profileType', 'creationTimestamp', 'lastModifiedTimestamp']
POST/v1/dashboard/clusterprofiles
Retrieves a list of cluster profiles filter summary Supported filter fields - ["profileName", "tags", "profileType", "environment"] Supported sort fields - ["profileName", "environment", "profileType", "creationTimestamp", "lastModifiedTimestamp"]
Request
Query Parameters
Possible values: <= 20
limit is a maximum number of responses to return for a list call. Maximum value of the limit is 20.
If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.
offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
continue token to paginate the subsequent data items
Header Parameters
Scope the request to the specified project uid
- application/json
Body
Array [
]
filter
Cluster profile filter spec
Possible values: [full, none, partial, unknown]
Default value: none
profileName
object
Default value: true
Possible values: [cluster, infra, add-on, system]
Possible values: [system, tenant, project]
tags
object
Default value: true
version
object
sort
undefined[]
Possible values: [profileName, environment, profileType, creationTimestamp, lastModifiedTimestamp]
Possible values: [asc, desc]
Default value: asc
Responses
- 200
An array of cluster profiles summary items
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
Array [
]
Array [
]
]
items
object[]
required
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
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.
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
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.
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
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
packs
undefined[]
annotations
object
Possible values: [kernel, os, k8s, cni, csi, addon]
published
object
Cluster profile template summary
packs
undefined[]
annotations
object
Possible values: [kernel, os, k8s, cni, csi, addon]
Cluster profile's latest version
versions
undefined[]
Cluster profile's list of all the versions
status
object
ClusterProfileStatusSummary defines the observed state of ClusterProfile
fips
Cluster profile fips compliance status
Possible values: [full, none, partial, unknown]
Default value: none
Deprecated. Use inUseClusters
inUseClusters
object[]
pack
object
Cluster profile packs summary about the deprecated, disabled, deleted packs count
Total count of deleted packs in a cluster profile
Total count of deprecated packs in a cluster profile
Total count of disabled packs in a cluster profile
listmeta
object
ListMeta describes metadata for the resource listing
Next token for the pagination. Next token is equal to empty string indicates end of result set.
Total count of the resources which might change during pagination based on the resources addition or deletion
Number of records feteched
The next offset for the pagination. Starting index for which next request will be placed.
{
"items": [
{
"metadata": {
"annotations": {},
"creationTimestamp": "2024-07-02T18:20:57.808Z",
"deletionTimestamp": "2024-07-02T18:20:57.808Z",
"labels": {},
"lastModifiedTimestamp": "2024-07-02T18:20:57.808Z",
"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
}
}
}
],
"listmeta": {
"continue": "string",
"count": 0,
"limit": 0,
"offset": 0
}
}