Retrieves a list of cluster summary for a given cluster group
POST/v1/dashboard/clustergroups/:uid/virtualClusters
Retrieves a list of cluster summary for a given cluster group
Request
Path Parameters
Query Parameters
Default value: 50
limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
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 [
Array [
]
]
Array [
]
filter
Possible values: [and
, or
]
filterGroups
undefined[]
Possible values: [and
, or
]
filters
undefined[]
condition
bool
date
match
Possible values: [and
, or
]
Possible values: [eq
, gt
, gte
, lt
, lte
, range
]
float
match
Possible values: [and
, or
]
Possible values: [eq
, gt
, gte
, lt
, lte
]
int
match
Possible values: [and
, or
]
Possible values: [eq
, gt
, gte
, lt
, lte
]
keyValue
match
Possible values: [and
, or
]
Possible values: [eq
, contains
, beginsWith
]
string
match
Possible values: [and
, or
]
Possible values: [eq
, contains
, beginsWith
]
Possible values: [string
, int
, float
, bool
, date
, keyValue
]
sort
undefined[]
Possible values: [environment
, clusterName
, clusterState
, healthState
, creationTimestamp
, lastModifiedTimestamp
]
Possible values: [asc
, desc
]
Default value: asc
Responses
- 200
An array of cluster summary items
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
Array [
]
Array [
]
Array [
]
]
]
Array [
Array [
]
Array [
]
Array [
]
]
Array [
Array [
Array [
]
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 are system generated key value metadata for the resource. As an input certain annotations like description can be set.
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
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
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 of the resource.
UID is the unique identifier generated for the resource. This is not an input field for any request.
specSummary
object
Spectro cluster spec summary
Possible values: [amd64
, arm64
]
Architecture type of the cluster
cloudAccountMeta
object
Cloud account meta information
cloudConfig
object
machinePools
object[]
Machine pool meta information
number of healthy machines
infraProfileTemplate
object
InfraClusterProfile contains OS/Kernel for this NodePool
Cluster profile name
packs
object[]
Cluster profile packs array
annotations
object
Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml
digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade
pack is invalid when the associated tag is deleted from the registry
Possible values: [kernel
, os
, k8s
, cni
, csi
, addon
]
path to the pack logo
manifests
object[]
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent.
UID of the referent.
pack name
PackUID is Hubble packUID, not palette Pack.UID It is used by Hubble only.
params
object
params passed as env variables to be consumed at installation time
presets
object[]
pack registry uid
schema
object[]
pack registry server or helm repo
pack tag
Possible values: [spectro
, helm
, manifest
]
type of the pack
values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values
pack version
scope or context(system, tenant or project)
Cluster profile type [ "cluster", "infra", "add-on", "system" ]
Cluster profile uid
whether this pool is for control plane
labels for this pool, example: master/worker, gpu, windows
number of machines under maintenance
size of the pool, number of machines
Cluster's cloud config uid
clusterConfig
object
hostClusterConfig
HostClusterConfig defines the configuration entity of host clusters config entity
clusterGroup
object
ObjectReference contains enough information to let you inspect or modify the referred object.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent.
UID of the referent.
clusterProfileTemplate
object
Cluster profile template meta information
Cluster profile name
packs
object[]
Cluster profile packs array
annotations
object
Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml
digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade
pack is invalid when the associated tag is deleted from the registry
Possible values: [kernel
, os
, k8s
, cni
, csi
, addon
]
path to the pack logo
manifests
object[]
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent.
UID of the referent.
pack name
PackUID is Hubble packUID, not palette Pack.UID It is used by Hubble only.
params
object
params passed as env variables to be consumed at installation time
presets
object[]
pack registry uid
schema
object[]
pack registry server or helm repo
pack tag
Possible values: [spectro
, helm
, manifest
]
type of the pack
values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values
pack version
scope or context(system, tenant or project)
Cluster profile type [ "cluster", "infra", "add-on", "system" ]
Cluster profile uid
clusterProfileTemplates
object[]
Cluster profile name
packs
object[]
Cluster profile packs array
annotations
object
Annotations is used to allow packref to add more arbitrary information one example is to add git reference for values.yaml
digest is used to specify the version should be installed by palette when pack upgrade available, change this digest to trigger upgrade
pack is invalid when the associated tag is deleted from the registry
Possible values: [kernel
, os
, k8s
, cni
, csi
, addon
]
path to the pack logo
manifests
object[]
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Name of the referent.
UID of the referent.
pack name
PackUID is Hubble packUID, not palette Pack.UID It is used by Hubble only.
params
object
params passed as env variables to be consumed at installation time
presets
object[]
pack registry uid
schema
object[]
pack registry server or helm repo
pack tag
Possible values: [spectro
, helm
, manifest
]
type of the pack
values represents the values.yaml used as input parameters either Params OR Values should be used, not both If both applied at the same time, will only use Values
pack version
scope or context(system, tenant or project)
Cluster profile type [ "cluster", "infra", "add-on", "system" ]
Cluster profile uid
projectMeta
object
status
Spectro cluster status summary
clusterImport
object
import link to download and install ally-lite, palette-lite
Deprecated. Use the 'spec.clusterType'
cluster import status
cost
object
Resource Cost information
cloud
object
Cloud cost information
fips
Possible values: [full
, none
, partial
, unknown
]
Default value: none
health
Spectro cluster health status
conditions
undefined[]
relatedObject
object
Object for which the resource is related
Possible values: [spectrocluster
, machine
, cloudconfig
, clusterprofile
, pack
, appprofile
, appdeployment
, edgehost
]
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.
hourlyRate
object
Resource Cost information
cloud
object
Cloud cost information
location
object
Cluster location information
metrics
Spectro cluster metrics
cpu
object
Compute metrics
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.
memory
object
Compute metrics
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.
notifications
Spectro cluster notifications
repave
Cluster repave status
Possible values: [Pending
, Approved
, Reverted
]
Default value: Pending
virtual
appDeployments
object[]
list of apps deployed on the virtual cluster
clusterGroup
object
Object resource reference
hostCluster
object
Object resource reference
lifecycleStatus
cluster life cycle status of virtual cluster
error or success msg of lifecycle
Possible values: [Pausing
, Paused
, Resuming
, Running
, Error
]
lifecycle status
cluster virtual host status
virtualClusters
object[]
list of virtual clusters deployed on the cluster
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-03T22:20:38.761Z",
"deletionTimestamp": "2024-07-03T22:20:38.761Z",
"labels": {},
"lastModifiedTimestamp": "2024-07-03T22:20:38.761Z",
"name": "string",
"uid": "string"
},
"specSummary": {
"archTypes": [
"amd64"
],
"cloudAccountMeta": {
"name": "string",
"uid": "string"
},
"cloudConfig": {
"cloudType": "string",
"machinePools": [
{
"cloudType": "string",
"healthy": 0,
"infraProfileTemplate": {
"cloudType": "string",
"name": "string",
"packs": [
{
"annotations": {},
"digest": "string",
"inValidReason": "string",
"isInvalid": true,
"layer": "kernel",
"logo": "string",
"manifests": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"name": "string",
"packUid": "string",
"params": {},
"presets": [
{
"add": "string",
"displayName": "string",
"group": "string",
"name": "string",
"remove": [
"string"
]
}
],
"registryUid": "string",
"schema": [
{
"format": "string",
"hints": [
"string"
],
"listOptions": [
"string"
],
"name": "string",
"readonly": true,
"regex": "string",
"required": true,
"type": "string"
}
],
"server": "string",
"tag": "string",
"type": "spectro",
"values": "string",
"version": "string"
}
],
"scope": "string",
"type": "string",
"uid": "string",
"version": 0
},
"isControlPlane": true,
"labels": [
"string"
],
"maintenanceMode": 0,
"size": 0
}
],
"uid": "string"
},
"clusterConfig": {
"hostClusterConfig": {
"clusterGroup": {
"kind": "string",
"name": "string",
"uid": "string"
}
}
},
"clusterProfileTemplate": {
"cloudType": "string",
"name": "string",
"packs": [
{
"annotations": {},
"digest": "string",
"inValidReason": "string",
"isInvalid": true,
"layer": "kernel",
"logo": "string",
"manifests": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"name": "string",
"packUid": "string",
"params": {},
"presets": [
{
"add": "string",
"displayName": "string",
"group": "string",
"name": "string",
"remove": [
"string"
]
}
],
"registryUid": "string",
"schema": [
{
"format": "string",
"hints": [
"string"
],
"listOptions": [
"string"
],
"name": "string",
"readonly": true,
"regex": "string",
"required": true,
"type": "string"
}
],
"server": "string",
"tag": "string",
"type": "spectro",
"values": "string",
"version": "string"
}
],
"scope": "string",
"type": "string",
"uid": "string",
"version": 0
},
"clusterProfileTemplates": [
{
"cloudType": "string",
"name": "string",
"packs": [
{
"annotations": {},
"digest": "string",
"inValidReason": "string",
"isInvalid": true,
"layer": "kernel",
"logo": "string",
"manifests": [
{
"kind": "string",
"name": "string",
"uid": "string"
}
],
"name": "string",
"packUid": "string",
"params": {},
"presets": [
{
"add": "string",
"displayName": "string",
"group": "string",
"name": "string",
"remove": [
"string"
]
}
],
"registryUid": "string",
"schema": [
{
"format": "string",
"hints": [
"string"
],
"listOptions": [
"string"
],
"name": "string",
"readonly": true,
"regex": "string",
"required": true,
"type": "string"
}
],
"server": "string",
"tag": "string",
"type": "spectro",
"values": "string",
"version": "string"
}
],
"scope": "string",
"type": "string",
"uid": "string",
"version": 0
}
],
"projectMeta": {
"name": "string",
"uid": "string"
}
},
"status": {
"clusterImport": {
"importLink": "string",
"isBrownfield": true,
"state": "string"
},
"cost": {
"cloud": {
"compute": 0,
"storage": 0,
"total": 0
},
"total": 0
},
"fips": {
"mode": "none"
},
"health": {
"agentVersion": "string",
"conditions": [
{
"message": "string",
"relatedObject": {
"kind": "spectrocluster",
"name": "string",
"uid": "string"
},
"type": "string"
}
],
"lastHeartBeatTimestamp": "2024-07-03T22:20:38.762Z",
"state": "string"
},
"hourlyRate": {
"cloud": {
"compute": 0,
"storage": 0,
"total": 0
},
"total": 0
},
"location": {
"coordinates": [
0
],
"countryCode": "string",
"countryName": "string",
"regionCode": "string",
"regionName": "string"
},
"metrics": {
"cpu": {
"lastUpdatedTime": "2024-07-03T22:20:38.763Z",
"limit": 0,
"request": 0,
"total": 0,
"unit": "string",
"usage": 0
},
"memory": {
"lastUpdatedTime": "2024-07-03T22:20:38.763Z",
"limit": 0,
"request": 0,
"total": 0,
"unit": "string",
"usage": 0
}
},
"notifications": {
"isAvailable": true
},
"repave": {
"state": "Pending"
},
"state": "string",
"virtual": {
"appDeployments": [
{
"kind": "string",
"name": "string",
"projectUid": "string",
"tenantUid": "string",
"uid": "string"
}
],
"clusterGroup": {
"kind": "string",
"name": "string",
"projectUid": "string",
"tenantUid": "string",
"uid": "string"
},
"hostCluster": {
"kind": "string",
"name": "string",
"projectUid": "string",
"tenantUid": "string",
"uid": "string"
},
"lifecycleStatus": {
"msg": "string",
"status": "Pausing"
},
"state": "string",
"virtualClusters": [
{
"kind": "string",
"name": "string",
"projectUid": "string",
"tenantUid": "string",
"uid": "string"
}
]
}
}
}
],
"listmeta": {
"continue": "string",
"count": 0,
"limit": 0,
"offset": 0
}
}