→
https://api.spectrocloud.com/v1alpha1/dashboard/clusterprofiles
summary:
Retrieves a list of cluster profiles summaryParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| cloudType | string | no | |
| limit | integer | limit is a maximum number of responses to return for a list call. 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. | no |
| continue | string | continue token for the dataset | no |
200
An array of cluster profile summary items
An array of cluster profile summary items
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"specSummary": {"draft": {"cloudType": "string","packs": [{"addonType": "string","displayName": "string","layer": "string","name": "string","packUid": "string","tag": "string","version": "string"}],"version": "integer"},"published": {"cloudType": "string","packs": [{"addonType": "string","displayName": "string","layer": "string","name": "string","packUid": "string","tag": "string","version": "string"}],"version": "integer"}},"status": {"isPublished": "boolean"}}],"listmeta": {"continue": "string","count": "integer"}}
→
https://api.spectrocloud.com/v1alpha1/dashboard/clusterprofiles
summary:
Retrieves a list of cluster profiles filter summaryParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| limit | integer | limit is a maximum number of responses to return for a list call. 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. | no |
| continue | string | continue token for the dataset | no |
{"filter": {"environment": ["string"],"profileName": {"beginsWith": "string","eq": "string","ne": "string"},"profileType": ["string"]},"sort": [{"field": "string","order": "string"}]}
200
An array of cluster profiles summary items
An array of cluster profiles summary items
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"specSummary": {"draft": {"cloudType": "string","packs": [{"addonType": "string","displayName": "string","layer": "string","name": "string","packUid": "string","tag": "string","version": "string"}],"version": "integer"},"published": {"cloudType": "string","packs": [{"addonType": "string","displayName": "string","layer": "string","name": "string","packUid": "string","tag": "string","version": "string"}],"version": "integer"}},"status": {"isPublished": "boolean"}}],"listmeta": {"continue": "string","count": "integer"}}
→
https://api.spectrocloud.com/v1alpha1/dashboard/projects
summary:
Retrieves a list of project summaryParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| limit | integer | limit is a maximum number of responses to return for a list call. 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. | no |
| continue | string | continue token for the dataset | no |
| metricPeriod | integer | Metric period in minutes defines latest metrics by period | no |
200
An array of project summary items
An array of project summary items
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"specSummary": {"logoUrl": "string","teams": [{"name": "string","uid": "string"}],"users": [{"name": "string","uid": "string"}]},"status": {"clustersHealth": {"errored": "integer","healthy": "integer","running": "integer","unhealthy": "integer"},"usage": {"clusters": [{"cpuCores": "number","name": "string","uid": "string"}],"cpuCores": "number"}}}],"listmeta": {"continue": "string","count": "integer"}}
→
https://api.spectrocloud.com/v1alpha1/dashboard/spectroclusters
summary:
Retrieves a list of cluster summaryParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| limit | integer | limit is a maximum number of responses to return for a list call. 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. | no |
| continue | string | continue token for the dataset | no |
| metricPeriod | integer | Metric period in minutes defines latest metrics by period | no |
200
An array of cluster summary items
An array of cluster summary items
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"specSummary": {"cloudConfig": {"cloudType": "string","machinePools": [{"cloudType": "string","infraProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"labels": ["string"],"size": "integer"}]},"clusterProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"clusterProfileTemplates": [{"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"}]},"status": {"clusterImport": {"importLink": "string","isBrownfield": "boolean","state": "string"},"health": {"agentVersion": "string","conditions": [{"message": "string","relatedObject": {"kind": "string","name": "string","uid": "string"},"type": "string"}],"state": "string"},"metrics": {"cpu": {"lastUpdatedTime": "date-time","limit": "number","request": "number","total": "number","unit": "string","usage": "number"},"memory": {"lastUpdatedTime": "date-time","limit": "number","request": "number","total": "number","unit": "string","usage": "number"}},"notifications": {"isAvailable": "boolean"},"state": "string"}}],"listmeta": {"continue": "string","count": "integer"}}
→
https://api.spectrocloud.com/v1alpha1/dashboard/spectroclusters
summary:
Retrieves a list of cluster summary with provided filter specParameters:
| Name | Type | Description | Required |
|---|---|---|---|
| limit | integer | limit is a maximum number of responses to return for a list call. 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. | no |
| continue | string | continue token for the dataset | no |
{"filter": {"clusterName": {"beginsWith": "string","eq": "string","ne": "string"},"cpuUsage": {"eq": "integer","gt": "integer","gte": "integer","lt": "integer","lte": "integer","ne": "integer"},"environment": ["string"],"healthState": "string","isDeleted": "boolean","memoryUsage": {"eq": "number","gt": "number","gte": "number","lt": "number","lte": "number","ne": "number"},"metricPeriod": "integer"},"sort": [{"field": "string","order": "string"}]}
200
An array of cluster summary items
An array of cluster summary items
{"items": [{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"specSummary": {"cloudConfig": {"cloudType": "string","machinePools": [{"cloudType": "string","infraProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"labels": ["string"],"size": "integer"}]},"clusterProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"clusterProfileTemplates": [{"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"}]},"status": {"clusterImport": {"importLink": "string","isBrownfield": "boolean","state": "string"},"health": {"agentVersion": "string","conditions": [{"message": "string","relatedObject": {"kind": "string","name": "string","uid": "string"},"type": "string"}],"state": "string"},"metrics": {"cpu": {"lastUpdatedTime": "date-time","limit": "number","request": "number","total": "number","unit": "string","usage": "number"},"memory": {"lastUpdatedTime": "date-time","limit": "number","request": "number","total": "number","unit": "string","usage": "number"}},"notifications": {"isAvailable": "boolean"},"state": "string"}}],"listmeta": {"continue": "string","count": "integer"}}
→
https://api.spectrocloud.com/v1alpha1/dashboard/spectroclusters/{uid}
summary:
Returns the specified cluster summaryPath parameters:
| Name | Type | Description | Required |
|---|---|---|---|
| uid | string | yes |
200
An spectro cluster summary
An spectro cluster summary
{"metadata": {"annotations": "object","creationTimestamp": "date-time","deletionTimestamp": "date-time","labels": "object","name": "string","namespace": "string","resourceVersion": "string","selfLink": "string","uid": "string"},"spec": {"cloudConfig": {"cloudType": "string","machinePools": [{"cloudType": "string","infraProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"labels": ["string"],"size": "integer"}]},"cloudaccount": {"name": "string","uid": "string"},"clusterProfileTemplate": {"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"},"clusterProfileTemplates": [{"cloudType": "string","name": "string","packs": [{"annotations": "object","digest": "string","inValidReason": "string","isInvalid": "boolean","layer": "string","name": "string","packUid": "string","params": "object","presets": [{"add": "string","displayName": "string","group": "string","name": "string","remove": ["string"]}],"schema": [{"format": "string","hints": ["string"],"listOptions": ["string"],"name": "string","regex": "string","required": "boolean","type": "string"}],"server": "string","tag": "string","values": "string","version": "string"}],"type": "string","uid": "string","version": "integer"}]},"status": {"apiEndpoints": [{"host": "string","port": "integer"}],"clusterImport": {"importLink": "string","isBrownfield": "boolean","state": "string"},"conditions": [{"lastProbeTime": "date-time","lastTransitionTime": "date-time","message": "string","reason": "string","status": "string","type": "string"}],"health": {"agentVersion": "string","conditions": [{"message": "string","relatedObject": {"kind": "string","name": "string","uid": "string"},"type": "string"}],"state": "string"},"services": [{"host": "string","name": "string","ports": [{"port": "integer","protocol": "string"}]}],"state": "string"}}