Retrieves specified workspace clusters workload pods

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

Retrieves specified workspace clusters workload pods

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 pods

application/json

Schema

Schema

clusters object[]
Array [
metadata object
Object for which the resource is related
kindstring
Possible values: [spectrocluster, machine, cloudconfig, clusterprofile, pack, appprofile, appdeployment, edgehost]
namestring
uidstring
pods object[]
Array [
metadata object
Cluster workload pod metadata
associatedRefs object[]
Array [
kindstring
namestring
uidstring
]
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
machineUidstring
namespacestring
nodenamestring
spec object
Cluster workload pod spec
containers object[]
Array [
imagestring
namestring
resources object
Cluster workload pod container resources
limits object
Cluster workload pod container resource
cpuint32
cpuUnitstring
memoryint64
memoryUnitstring
requests object
Cluster workload pod container resource
cpuint32
cpuUnitstring
memoryint64
memoryUnitstring
]
volumes object[]
Array [
namestring
]
status object
Cluster workload pod status
containers object[]
Array [
imagestring
namestring
readyboolean
restartCountint32
startedboolean
state object
Cluster workload pod container state
exitCodeint32
finishedAtdate-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.
reasonstring
startedAtdate-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.
statestring
]
phasestring
podIpstring
qosClassstring
]
]
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": [
    {
      "metadata": {
        "kind": "spectrocluster",
        "name": "string",
        "uid": "string"
      },
      "pods": [
        {
          "metadata": {
            "associatedRefs": [
              {
                "kind": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "creationTimestamp": "2023-12-01T21:31:48.598Z",
            "entity": {
              "kind": "string",
              "name": "string",
              "uid": "string"
            },
            "labels": {},
            "machineUid": "string",
            "namespace": "string",
            "nodename": "string"
          },
          "spec": {
            "containers": [
              {
                "image": "string",
                "name": "string",
                "resources": {
                  "limits": {
                    "cpu": 0,
                    "cpuUnit": "string",
                    "memory": 0,
                    "memoryUnit": "string"
                  },
                  "requests": {
                    "cpu": 0,
                    "cpuUnit": "string",
                    "memory": 0,
                    "memoryUnit": "string"
                  }
                }
              }
            ],
            "volumes": [
              {
                "name": "string"
              }
            ]
          },
          "status": {
            "containers": [
              {
                "image": "string",
                "name": "string",
                "ready": true,
                "restartCount": 0,
                "started": true,
                "state": {
                  "exitCode": 0,
                  "finishedAt": "2023-12-01T21:31:48.598Z",
                  "reason": "string",
                  "startedAt": "2023-12-01T21:31:48.598Z",
                  "state": "string"
                }
              }
            ],
            "phase": "string",
            "podIp": "string",
            "qosClass": "string"
          }
        }
      ]
    }
  ],
  "metadata": {
    "annotations": {},
    "labels": {},
    "name": "string"
  }
}

Loading...