Retrieves specified cluster workloads

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

Retrieves specified cluster workloads

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 workloads

application/json

Schema

Schema

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

spec object
Cluster workload spec
clusterroleBindings 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
spec object
Cluster RBAC binding
namespacestring
role object
Cluster role ref
kindstring
Possible values: [Role, ClusterRole]
namestring
subjects object[]
Array [
namestring
namespacestring
typestring
Possible values: [User, Group, ServiceAccount]
]
typestring
Possible values: [RoleBinding, ClusterRoleBinding]
]
cronJobs 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
spec object
Cluster workload cronjob spec
schedulestring
status object
Cluster workload cronjob status
lastScheduleTimedate-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.
]
daemonSets 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 daemonset status
availableint32
currentScheduledint32
desiredScheduledint32
misScheduledint32
readyint32
updatedScheduledint32
]
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
]
jobs 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 job status
completionTimedate-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.
conditions object[]
Array [
lastTransitionTimedate-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.
lastUpdateTimedate-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.
messagestring
reasonstring
statusstring
typestring
]
startTimedate-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.
succeededint32
]
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
]
roleBindings 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
spec object
Cluster RBAC binding
namespacestring
role object
Cluster role ref
kindstring
Possible values: [Role, ClusterRole]
namestring
subjects object[]
Array [
namestring
namespacestring
typestring
Possible values: [User, Group, ServiceAccount]
]
typestring
Possible values: [RoleBinding, ClusterRoleBinding]
]
statefulSets 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 statefulset status
replicas object
Cluster workload replica status
availableint32
readyint32
totalint32
updatedint32
]

Example (from schema)

{
  "metadata": {
    "annotations": {},
    "labels": {},
    "name": "string"
  },
  "spec": {
    "clusterroleBindings": [
      {
        "metadata": {
          "creationTimestamp": "2023-12-01T21:31:48.579Z",
          "entity": {
            "kind": "string",
            "name": "string",
            "uid": "string"
          },
          "labels": {},
          "namespace": "string"
        },
        "spec": {
          "namespace": "string",
          "role": {
            "kind": "Role",
            "name": "string"
          },
          "subjects": [
            {
              "name": "string",
              "namespace": "string",
              "type": "User"
            }
          ],
          "type": "RoleBinding"
        }
      }
    ],
    "cronJobs": [
      {
        "metadata": {
          "creationTimestamp": "2023-12-01T21:31:48.579Z",
          "entity": {
            "kind": "string",
            "name": "string",
            "uid": "string"
          },
          "labels": {},
          "namespace": "string"
        },
        "spec": {
          "schedule": "string"
        },
        "status": {
          "lastScheduleTime": "2023-12-01T21:31:48.579Z"
        }
      }
    ],
    "daemonSets": [
      {
        "metadata": {
          "creationTimestamp": "2023-12-01T21:31:48.579Z",
          "entity": {
            "kind": "string",
            "name": "string",
            "uid": "string"
          },
          "labels": {},
          "namespace": "string"
        },
        "status": {
          "available": 0,
          "currentScheduled": 0,
          "desiredScheduled": 0,
          "misScheduled": 0,
          "ready": 0,
          "updatedScheduled": 0
        }
      }
    ],
    "deployments": [
      {
        "metadata": {
          "creationTimestamp": "2023-12-01T21:31:48.579Z",
          "entity": {
            "kind": "string",
            "name": "string",
            "uid": "string"
          },
          "labels": {},
          "namespace": "string"
        },
        "status": {
          "replicas": {
            "available": 0,
            "ready": 0,
            "total": 0,
            "updated": 0
          }
        }
      }
    ],
    "jobs": [
      {
        "metadata": {
          "creationTimestamp": "2023-12-01T21:31:48.579Z",
          "entity": {
            "kind": "string",
            "name": "string",
            "uid": "string"
          },
          "labels": {},
          "namespace": "string"
        },
        "status": {
          "completionTime": "2023-12-01T21:31:48.579Z",
          "conditions": [
            {
              "lastTransitionTime": "2023-12-01T21:31:48.579Z",
              "lastUpdateTime": "2023-12-01T21:31:48.579Z",
              "message": "string",
              "reason": "string",
              "status": "string",
              "type": "string"
            }
          ],
          "startTime": "2023-12-01T21:31:48.579Z",
          "succeeded": 0
        }
      }
    ],
    "pods": [
      {
        "metadata": {
          "associatedRefs": [
            {
              "kind": "string",
              "name": "string",
              "uid": "string"
            }
          ],
          "creationTimestamp": "2023-12-01T21:31:48.579Z",
          "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.579Z",
                "reason": "string",
                "startedAt": "2023-12-01T21:31:48.579Z",
                "state": "string"
              }
            }
          ],
          "phase": "string",
          "podIp": "string",
          "qosClass": "string"
        }
      }
    ],
    "roleBindings": [
      {
        "metadata": {
          "creationTimestamp": "2023-12-01T21:31:48.579Z",
          "entity": {
            "kind": "string",
            "name": "string",
            "uid": "string"
          },
          "labels": {},
          "namespace": "string"
        },
        "spec": {
          "namespace": "string",
          "role": {
            "kind": "Role",
            "name": "string"
          },
          "subjects": [
            {
              "name": "string",
              "namespace": "string",
              "type": "User"
            }
          ],
          "type": "RoleBinding"
        }
      }
    ],
    "statefulSets": [
      {
        "metadata": {
          "creationTimestamp": "2023-12-01T21:31:48.579Z",
          "entity": {
            "kind": "string",
            "name": "string",
            "uid": "string"
          },
          "labels": {},
          "namespace": "string"
        },
        "status": {
          "replicas": {
            "available": 0,
            "ready": 0,
            "total": 0,
            "updated": 0
          }
        }
      }
    ]
  }
}

Loading...