Retrieves specified workspace clusters workload statefulsets

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

Retrieves specified workspace clusters workload statefulsets

Request

Path Parameters

uid stringrequired

application/json

Body

filter

object

Workspace workloads filter

clustersstring[]

namespacesstring[]

Responses

200

An array of clusters workload statefulsets

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

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

]

]

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"
      },
      "statefulSets": [
        {
          "metadata": {
            "creationTimestamp": "2024-07-02T12:47:10.936Z",
            "entity": {
              "kind": "string",
              "name": "string",
              "uid": "string"
            },
            "labels": {},
            "namespace": "string"
          },
          "status": {
            "replicas": {
              "available": 0,
              "ready": 0,
              "total": 0,
              "updated": 0
            }
          }
        }
      ]
    }
  ],
  "metadata": {
    "annotations": {},
    "labels": {},
    "name": "string"
  }
}

• curl
• python
• go
• nodejs
• java

• CURL

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

Request Collapse all

Base URL

https://api.spectrocloud.com

Parameters

uid — pathrequired

Body

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