Retrieves specified spectro cluster resource consumption

POST 
/v1/dashboard/spectroclusters/:uid/resources/consumption

Retrieves specified spectro cluster resource consumption

Request

Path Parameters

uid stringrequired

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

filter object
Resource consumption 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[]
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.
workspacesstring[]
options object

Resource consumption options

enableSummaryViewboolean

Default value: true

groupBystring

Possible values: [tenant, project, workspace, cluster, namespace, cloud]

Default value: namespace

periodint32

Default value: 60

Responses

200

An array of resource consumption data items

application/json

Schema

Schema

cpuUnitstring
memoryUnitstring
resources object[]
Array [
associatedResources object[]
Array [
kindstring
namestring
uidstringrequired
]
data object[]
Array [
allotted object
Resource cosumption data
cpufloat64
memoryfloat64
timestampint64
usage object
Resource cosumption data
cpufloat64
memoryfloat64
]
entity object
kindstring
namestring
uidstringrequired
total object
Resource total cosumption data
allotted object
Resource cosumption data
cpufloat64
memoryfloat64
usage object
Resource cosumption data
cpufloat64
memoryfloat64
]
total object
Resource total cosumption data
allotted object
Resource cosumption data
cpufloat64
memoryfloat64
usage object
Resource cosumption data
cpufloat64
memoryfloat64

Example (from schema)

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

Loading...