Retrieves specified workspace clusters workload deployments

POST 
/v1/dashboard/workspaces/:uid/spectroclusters/workloads/deployment

Retrieves specified workspace clusters workload deployments

Request

Path Parameters

uid stringrequired

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

filter object
Workspace workloads filter
clustersstring[]
namespacesstring[]

Responses

200

An array of clusters workload deployments

application/json

Schema

Schema

clusters object[]
Array [
deployments object[]
Array [
metadata object
Cluster workload metadata
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.
entity object
Cluster workload ref
kindstring
namestring
uidstring
labels object
property name*string
namespacestring
status object
Cluster workload deployment status
replicas object
Cluster workload replica status
availableint32
readyint32
totalint32
updatedint32
]
metadata object
Object for which the resource is related
kindstring
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
namestring
uidstring
]
metadata object

ObjectMeta input entity for object creation

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

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

namestring

Name of the resource

Example (from schema)

{
  "clusters": [
    {
      "deployments": [
        {
          "metadata": {
            "creationTimestamp": "2023-12-01T21:31:48.594Z",
            "entity": {
              "kind": "string",
              "name": "string",
              "uid": "string"
            },
            "labels": {},
            "namespace": "string"
          },
          "status": {
            "replicas": {
              "available": 0,
              "ready": 0,
              "total": 0,
              "updated": 0
            }
          }
        }
      ],
      "metadata": {
        "kind": "spectrocluster",
        "name": "string",
        "uid": "string"
      }
    }
  ],
  "metadata": {
    "annotations": {},
    "labels": {},
    "name": "string"
  }
}

Loading...