Retrieves spectro clusters resources usage summary information

POST 
/v1/dashboard/spectroclusters/resources/usage

Retrieves spectro clusters resources usage summary information

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

filter object
Resource usage summary filter
cloudsstring[]
clustersstring[]
endTimedate-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.
includeMasterMachinesboolean
namespacesstring[]
podsstring[]
projectsstring[]
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.
workload object
Workload resource filter
namesstring[]
typestring
Possible values: [deployment, statefulset, daemonset, all]
Default value: all
workspacesstring[]
options object

Resource usage summary options

enableSummaryViewboolean

Default value: true

groupBystring

Possible values: [tenant, project, workspace, cluster, namespace, deployment, statefulset, daemonset, pod, cloud]

Default value: cluster

periodint32

Default value: 60

Responses

200

An array of resources usage summary items

application/json

Schema

Schema

cpuUnitstring
memoryUnitstring
resources object[]
Array [
associatedResources object[]
Array [
kindstring
namestring
uidstringrequired
]
data object[]
Array [
cpufloat64
memoryfloat64
timestampint64
]
entity object
kindstring
namestring
uidstringrequired
]

Example (from schema)

{
  "cpuUnit": "string",
  "memoryUnit": "string",
  "resources": [
    {
      "associatedResources": [
        {
          "kind": "string",
          "name": "string",
          "uid": "string"
        }
      ],
      "data": [
        {
          "cpu": 0,
          "memory": 0,
          "timestamp": 0
        }
      ],
      "entity": {
        "kind": "string",
        "name": "string",
        "uid": "string"
      }
    }
  ]
}

Loading...