Retrieves specified cluster workload pods

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

Retrieves specified cluster workload pods

Request

Path Parameters

uid stringrequired

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

filter

object

Cluster workloads filter

namespacesstring[]

Responses

200

An array of cluster workload pods

application/json

Schema

Schema

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

]

Example (from schema)

{
  "pods": [
    {
      "metadata": {
        "associatedRefs": [
          {
            "kind": "string",
            "name": "string",
            "uid": "string"
          }
        ],
        "creationTimestamp": "2024-07-02T12:47:33.300Z",
        "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-02T12:47:33.300Z",
              "reason": "string",
              "startedAt": "2024-07-02T12:47:33.300Z",
              "state": "string"
            }
          }
        ],
        "phase": "string",
        "podIp": "string",
        "qosClass": "string"
      }
    }
  ]
}

• curl
• python
• go
• nodejs
• java

• CURL

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

uid — pathrequired

ProjectUid — header

Body

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