Retrieves specified workspace clusters workload pods

POST 
https://api.spectrocloud.com/v1/dashboard/workspaces/:uid/spectroclusters/workloads/pod

Retrieves specified workspace clusters workload pods

Request

Path Parameters

uid stringrequired

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 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

property name*string

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

property name*string

namestring

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

Example (from schema)

{
  "clusters": [
    {
      "metadata": {
        "kind": "spectrocluster",
        "name": "string",
        "uid": "string"
      },
      "pods": [
        {
          "metadata": {
            "associatedRefs": [
              {
                "kind": "string",
                "name": "string",
                "uid": "string"
              }
            ],
            "creationTimestamp": "2024-07-29T15:51:28.071Z",
            "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": "2024-07-29T15:51:28.071Z",
                  "reason": "string",
                  "startedAt": "2024-07-29T15:51:28.071Z",
                  "state": "string"
                }
              }
            ],
            "phase": "string",
            "podIp": "string",
            "qosClass": "string"
          }
        }
      ]
    }
  ],
  "metadata": {
    "annotations": {},
    "labels": {},
    "name": "string"
  }
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L 'https://api.spectrocloud.com/v1/dashboard/workspaces/:uid/spectroclusters/workloads/pod' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "filter": {
    "clusters": [
      "string"
    ],
    "namespaces": [
      "string"
    ]
  }
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Parameters

uid — pathrequired

Body

{
  "filter": {
    "clusters": [
      "string"
    ],
    "namespaces": [
      "string"
    ]
  }
}