Skip to main content

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

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.

    includeControlPlaneMachinesboolean
    includeMasterMachinesboolean

    Deprecated. Use includeControlPlaneMachines

    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

    includeMeteringInfoboolean

    Default value: false

    periodint32

    Default value: 60

Responses

An array of resources usage summary items

Schema

    cpuUnitstring
    memoryUnitstring

    resources

    object[]

  • Array [

  • associatedResources

    object[]

  • Array [

  • kindstring
    namestring
    uidstringrequired
  • ]

  • data

    object[]

  • Array [

  • baremetal

    object

    min and max count for machines & edgehost for the given period

    activeEdgehostsint64
    activeMachinesint64
    maxEdgehostsint64
    maxMachinesint64
    cpufloat64

    edgehost

    object

    min and max count for machines & edgehost for the given period

    activeEdgehostsint64
    activeMachinesint64
    maxEdgehostsint64
    maxMachinesint64
    memoryfloat64
    timestampint64
  • ]

  • entity

    object

    kindstring
    namestring
    uidstringrequired
  • ]

Loading...